aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJonathan Weth <git@jonathanweth.de>2020-07-21 17:46:54 +0200
committerJonathan Weth <git@jonathanweth.de>2020-07-21 17:46:54 +0200
commit743492297d911bb296127cc0e95c16b0b0b4ce9f (patch)
treec8a5af84b10a9cf3689106a38279a3371bf7aa2f
parentd0779461c5d84534aa3008ec6563ba33a41feac6 (diff)
downloadRWA.Support.SessionService-743492297d911bb296127cc0e95c16b0b0b4ce9f.tar.gz
RWA.Support.SessionService-743492297d911bb296127cc0e95c16b0b0b4ce9f.tar.bz2
RWA.Support.SessionService-743492297d911bb296127cc0e95c16b0b0b4ce9f.zip
Update README
Close #2
-rw-r--r--README.md14
-rw-r--r--README.rst29
2 files changed, 29 insertions, 14 deletions
diff --git a/README.md b/README.md
deleted file mode 100644
index 2bf1caf..0000000
--- a/README.md
+++ /dev/null
@@ -1,14 +0,0 @@
-# DBus service for RWA
-
-# Setup
-1. Install dependencies
-
- sudo apt install python3 python3-venv python3-pip x11vnc
-
-2. Install poetry
-
- sudo pip3 install poetry
-
-3. Install service
-
- poetry install
diff --git a/README.rst b/README.rst
new file mode 100644
index 0000000..6b294b7
--- /dev/null
+++ b/README.rst
@@ -0,0 +1,29 @@
+Session Service for RWA client
+==============================
+DBus-service, written in Python 3,
+for managing sessions with Django and as a backend for GUI applications
+
+Setup (on Debian-based systems)
+-------------------------------
+1. Install dependencies via ``apt``
+
+ sudo apt install python3 python3-venv python3-pip x11vnc libcairo2-dev libdbus-glib-1-dev libgirepository1.0-dev
+
+2. Install Poetry
+
+ sudo pip3 install poetry
+
+3. Install python dependencies for session service
+
+ poetry install
+
+Testing
+-------
+
+1. Start service (must run in background):
+
+ poetry run python service.py
+
+2. Use test client to start a session (needs a running Django on localhost):
+
+ poetry run python test_client.py \ No newline at end of file