From 353766010f7f18132c0d4ece8bdddb63bdfec4fb Mon Sep 17 00:00:00 2001
From: Martin Vladic <martin.vladic@gmail.com>
Date: Mon, 11 Jul 2022 09:45:18 +0200
Subject: [PATCH] Create README.md

---
 README.md | 39 +++++++++++++++++++++++++++++++++++++++
 1 file changed, 39 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..92aebeb
--- /dev/null
+++ b/README.md
@@ -0,0 +1,39 @@
+### Ownership and License
+
+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.
+
+## Build
+
+#### Linux
+
+```
+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
+mkdir -p build/linux
+cd build/linux
+cmake ../..
+make
+```
+
+Start simulator with:
+
+```
+./eez-flow-template-sdl
+```
+
+#### 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.
+
+Also, execute: `git submodule update --init --recursive` inside `eez-flow-template-sdl`.
+
+Execute `cmake.bat`.
+
+Visual Studio solution is created in `\path\to\eez-flow-template-sdl\build\win32`.