Issue 6602 - Introduce watchextensions

README.md

Index: README.md
diff --git a/README.md b/README.md
new file mode 100644
index 0000000000000000000000000000000000000000..0543ffd3d63da1f34409a05da4474949ab682627
--- /dev/null
+++ b/README.md
@@ -0,0 +1,65 @@
+# WatchExtensions
+
+## Requirements
+ - [Python](https://www.python.org/) [2.7 | 3.5 | 3.6]
+   - when run with Python2.7, you will need the backport-package for Python3's
+     [configparser](https://pypi.org/project/configparser/)
+ - For running the tests, you will need [tox](http://tox.readthedocs.io/en/latest/index.html)
+   (tox will take care of installing additional dependecies)
+
+## Testing
+
+To run the tests, simply invoke tox on your command line:
+
+```
+$ tox
+```
+
+## Configuration
+
+Configuring the WatchExtensions is done via providing a `watchextensions.ini`
+in either your home folder, or in `/etc/`. Please refer to
+[watchextensions.ini.example](./watchextensions.ini.example) for possible
+contents.
+
+Please refer to the documentation of the hoster of your choice, in order to
+determine how to configure writable git repositories.
+
+## Usage
+
+```
+$ python watchextensions.py -h
+usage: watchextensions.py [-h] [-q] [-p] [-k] [-c CONFIG_PATH]
+
+optional arguments:
+  -h, --help            show this help message and exit
+  -q, --quiet           Suppress informational output.
+  -p, --push            Perfom a PUSH to the tracking repository.
+  -k, --keep-repository
+                        Keep the local repository
+  -c CONFIG_PATH, --config-path CONFIG_PATH
+                        Absolute path to a custom config file.
+```
+
+On a server, run by a cronjob, you may want to run `watchextensions.py` with
+the following parameters:
+
+```
+python watchextensions.py --quiet --push
+```
+
+in order to
+ * not write any output, except errors
+ * actually push newly tracked content to the tracking repositories.
+
+---
+
+On your local machine, you will most likely want to run
+```
+$ python watchextensions.py -k
+```
+
+in order to
+ * get informational output
+ * keep the temporary repository, in order to directly examine changes
+ * **not** push any changes to the tracking repository