diff --git a/readme.md b/readme.md
new file mode 100644
index 0000000..00590dd
--- /dev/null
+++ b/readme.md
@@ -0,0 +1,4 @@
+* all tools provide should work on Linux and on Windows, shell scripts are avoided
+* templates files must be generated at development time, generated files must be put into the repository
+* use ``generate.py`` in the umbrella project's root without any arguments to generate all template files in all subdirectories using the ``schema.json`` from the umbrella project's root
+* to start the API set the required env variables (see ``ENV.tmp``) and run ``test.py`` from the API subproject