commit c81a62a15175afaa1e706eec7b97924c0df8fe2c
parent 6be10ca7af5168dcfbc39b64c50fdcaee251ca75
Author: parazyd <parazyd@dyne.org>
Date: Mon, 5 Jun 2017 23:01:46 +0200
some documentation in the readme
Diffstat:
2 files changed, 16 insertions(+), 2 deletions(-)
diff --git a/Makefile b/Makefile
@@ -1,2 +0,0 @@
-clean:
- rm -f **/*.pyc
diff --git a/README.md b/README.md
@@ -9,9 +9,12 @@ third iteration of the software. The original version of amprolla was
not performing well in terms of speed, and the second version was never
finished - therefore this version has emerged.
+
Dependencies
------------
+amprolla requires at least Python 3.5, and some external modules for it.
+
### Devuan Ascii/Debian Stretch
```
@@ -23,3 +26,16 @@ gnupg2 python3-requests python3-gnupg
```
app-crypt/gnupg dev-python/requests dev-python/python-gnupg
```
+
+
+Basic usage
+-----------
+
+Edit `lib/config.py` to your needs, and then run `amprolla_init.py`. This
+will download the repositories we will merge afterwards. When this is done,
+you can now run `orchestrate.py` which will perform the merge, and finally
+sign the Release files needed.
+
+A `nginx` configuration for the amprolla server can be found in `contrib`.
+
+More information on amprolla should be found in the `doc` directory.
