Update README.md

This commit is contained in:
Martin Vladic 2022-07-12 14:07:51 +02:00
parent c20ea7651f
commit c07ac36825

View File

@ -2,7 +2,7 @@
The contributors are listed in CONTRIB.TXT. This project uses the GPL v3 license, see LICENSE.TXT. 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. 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 ## 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 update
sudo apt-get install -y git libsdl2-dev libsdl2-image-dev libsdl2-ttf-dev cmake build-essential libbsd-dev 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 {{projectDirPath}}
cd eez-flow-template-sdl
git submodule update --init --recursive
mkdir -p build/linux mkdir -p build/linux
cd build/linux cd build/linux
cmake ../.. cmake ../..
@ -23,17 +21,47 @@ make
Start simulator with: Start simulator with:
``` ```
./eez-flow-template-sdl ./{{projectName}}
``` ```
#### Windows #### Windows
Install [Visual Studio Community 2017](https://visualstudio.microsoft.com/downloads/) and [CMake](https://cmake.org/install/). 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.
Also, execute: `git submodule update --init --recursive` inside `eez-flow-template-sdl`. Download and install SDL2_Image development libraries for Windows from https://github.com/libsdl-org/SDL_image/releases.
Execute `cmake.bat`. Update these environment variables in `cmake.bat` according to the location (and version) where SDL2 and SDL2_Image has been installed:
Visual Studio solution is created in `\path\to\eez-flow-template-sdl\build\win32`. ```
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.
#### Emscripten
These instructions are for the Linux.
[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
```