From c07ac36825e73f8b5ee33c1301794a9ad753a8d3 Mon Sep 17 00:00:00 2001 From: Martin Vladic Date: Tue, 12 Jul 2022 14:07:51 +0200 Subject: [PATCH] Update README.md --- README.md | 46 +++++++++++++++++++++++++++++++++++++--------- 1 file changed, 37 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 92aebeb..0f84a5a 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ The contributors are listed in CONTRIB.TXT. This project uses the GPL v3 license, see LICENSE.TXT. This project uses the [C4.1 (Collective Code Construction Contract)](http://rfc.zeromq.org/spec:22) process for contributions. -To report an issue, use the [issues page](https://github.com/eez-open/eez-flow-template-sdl/issues) tracker. +To report an issue, use the [issues page](https://github.com/eez-open/eez-flow-template-stm32f469i-disco/issues) tracker. ## Build @@ -11,9 +11,7 @@ To report an issue, use the [issues page](https://github.com/eez-open/eez-flow-t ``` sudo apt-get update sudo apt-get install -y git libsdl2-dev libsdl2-image-dev libsdl2-ttf-dev cmake build-essential libbsd-dev -git clone https://github.com/eez-open/eez-flow-template-sdl -cd eez-flow-template-sdl -git submodule update --init --recursive +cd {{projectDirPath}} mkdir -p build/linux cd build/linux cmake ../.. @@ -23,17 +21,47 @@ make Start simulator with: ``` -./eez-flow-template-sdl +./{{projectName}} ``` + #### Windows Install [Visual Studio Community 2017](https://visualstudio.microsoft.com/downloads/) and [CMake](https://cmake.org/install/). -Use git to clone https://github.com/eez-open/eez-flow-template-sdl. +Download and install SDL2 development libraries for Windows from https://www.libsdl.org/download-2.0.php. + +Download and install SDL2_Image development libraries for Windows from https://github.com/libsdl-org/SDL_image/releases. + +Update these environment variables in `cmake.bat` according to the location (and version) where SDL2 and SDL2_Image has been installed: + +``` +set SDL2DIR=..\SDL2-2.0.14 +set SDL2IMAGEDIR=..\SDL2_image-2.0.4 +``` + +Execute `cmake.bat`: + +``` +cd {{projectDirPath}} +.\cmake.bat +``` + +Visual Studio solution is created in `{{projectDirPath}}\build\win32`. + +Use Visual Studio to build the solution. -Also, execute: `git submodule update --init --recursive` inside `eez-flow-template-sdl`. +#### Emscripten -Execute `cmake.bat`. +These instructions are for the Linux. -Visual Studio solution is created in `\path\to\eez-flow-template-sdl\build\win32`. +[Download and install Emscripten](https://emscripten.org/docs/getting_started/downloads.html) + +``` +source /path/to/emsdk/emsdk_env.sh +export EMSCRIPTEN=/path/to/emsdk/upstream/emscripten +mkdir -p {{projectDirPath}}/build/emscripten +cd {{projectDirPath}}/build/emscripten +cmake -DCMAKE_TOOLCHAIN_FILE=../../cmake/Emscripten.cmake -DCMAKE_BUILD_TYPE=Debug -G "Unix Makefiles" ../.. +make +```