add initial commit

1 files changed, 36 insertions, 0 deletions

diff --git a/Readme.md b/Readme.md
new file mode 100644
index 0000000..07b6e17
--- /dev/null
+++ b/Readme.md
@@ -0,0 +1,36 @@
+# simple script to generate random seating plans using LaTeX templates
+
+## Usage
+
+```
+usage: spgen.py [-h] [--duration DURATION | --week WEEK] template
+
+positional arguments:
+  template
+
+options:
+  -h, --help           show this help message and exit
+  --duration DURATION
+  --week WEEK
+
+```
+
+## Available Templates
+
+```
+templates
+└── 4x(2,5).tex
+
+1 directory, 1 file
+```
+
+## Requirements
+
+* python >= 3.11
+
+The requirements can be installed in virtual environment using [`pipenv`](https://pipenv.pypa.io/).
+
+## License
+
+The spgen.py program is licensed under the terms of the GNU General Public
+License version 3. A Copy of the license is included in the `LICENSE` file.