add readme

This commit is contained in:
Wolfgang Hottgenroth 2021-08-29 12:58:45 +02:00
parent b65b48a364
commit 61dc2b28e6
Signed by: wn
GPG Key ID: 6C1E5E531E0D5D7F

4
readme.md Normal file
View File

@ -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