Add readme

diff --git a/README.md b/README.md
new file mode 100644 (file)
index 0000000..33e0120
--- /dev/null
+++ b/README.md
@@ -0,0 +1,60 @@
+Simple Stage
+============
+
+This repository contains simple Stage situations. The goal is to understand the
+[Stage][1] simulator and the [Meson Build system][2].
+
+The project is published under [GPLv3 License][].
+
+[1]: https://playerproject.github.io/stage/
+[2]: https://mesonbuild.com/
+[GPLv3 License]: ./LICENSE
+
+
+Generic instructions
+====================
+
+Prerequisities
+--------------
+
+- You need to have the [Stage][1] simulator.
+- You must set proper paths in the `meson.build` file.
+
+Building
+--------
+
+    meson setup builddir
+    cd builddir
+    ninja
+
+Running
+-------
+
+- `STAGEPATH` must be set to directory containing `.so` modules (i.e.
+  `builddir`.)
+- `LD_LIBRARY_PATH` must be set to directory containing `libstage.so`.
+
+It's possible to put all the settings into the script `stage.sh`:
+
+    #!/bin/sh
+    STAGEPATH=. LD_LIBRARY_PATH=/path/to/stg/lib /path/to/stg/bin/stage $@
+
+And run the `stage.sh` from the `build` directory:
+
+    stage.sh ../worlds/test_track.world
+
+
+Simple situations
+=================
+
+Test race track
+---------------
+
+- Used world: `worlds/test_track.world`
+- Used car: `model/tx2-auto-3.model`
+- Used ctrl: `ctrl/goforward.cc`
+
+The _test race track_ and `tx2-auto-3` are used in F1/10 project of [IID][]
+group. The `libgoforward` controls the robot to just go straight.
+
+[IID]: https://iid.ciirc.cvut.cz/