aboutsummaryrefslogtreecommitdiff
path: root/README.rst
diff options
context:
space:
mode:
authorJonathan Weth <git@jonathanweth.de>2020-07-27 15:31:27 +0200
committerJonathan Weth <git@jonathanweth.de>2020-07-27 15:31:27 +0200
commitc63e4627ec0613f7fcc6d9a936c14a64a2655b33 (patch)
treef112d16b468b1bdb4cb99fd4b2398bf85d598a49 /README.rst
parent33cbf9670d6abde5544f8be0a837cd19ccb79973 (diff)
downloadRWA.Support.SessionService-c63e4627ec0613f7fcc6d9a936c14a64a2655b33.tar.gz
RWA.Support.SessionService-c63e4627ec0613f7fcc6d9a936c14a64a2655b33.tar.bz2
RWA.Support.SessionService-c63e4627ec0613f7fcc6d9a936c14a64a2655b33.zip
Add documentation
Diffstat (limited to 'README.rst')
-rw-r--r--README.rst27
1 files changed, 1 insertions, 26 deletions
diff --git a/README.rst b/README.rst
index 885a912..afeda9b 100644
--- a/README.rst
+++ b/README.rst
@@ -1,33 +1,8 @@
Session Service for RWA client
==============================
-DBus-service, written in Python 3,
+D-Bus 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 wget
-
-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
-
Licence
-------