From 743492297d911bb296127cc0e95c16b0b0b4ce9f Mon Sep 17 00:00:00 2001 From: Jonathan Weth Date: Tue, 21 Jul 2020 17:46:54 +0200 Subject: Update README Close #2 --- README.md | 14 -------------- README.rst | 29 +++++++++++++++++++++++++++++ 2 files changed, 29 insertions(+), 14 deletions(-) delete mode 100644 README.md create mode 100644 README.rst 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 -- cgit v1.2.3