aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDaniel Teichmann <daniel.teichmann@das-netzwerkteam.de>2023-02-21 11:46:43 +0000
committerDaniel Teichmann <daniel.teichmann@das-netzwerkteam.de>2023-02-21 11:46:43 +0000
commit692163a3282a6fc706f3e31e0884378b4bb0f464 (patch)
tree0282f9747bc6b3b232ab56c26d3e6826f24c5ad6
parentf1e0aed3d53e0178c6b9355e0e6eae18aa6d1837 (diff)
downloadRWA.Support.SessionService-692163a3282a6fc706f3e31e0884378b4bb0f464.tar.gz
RWA.Support.SessionService-692163a3282a6fc706f3e31e0884378b4bb0f464.tar.bz2
RWA.Support.SessionService-692163a3282a6fc706f3e31e0884378b4bb0f464.zip
README.rst: Add 'Getting Started' section + Update copyright.HEADmaster
-rw-r--r--README.rst40
1 files changed, 37 insertions, 3 deletions
diff --git a/README.rst b/README.rst
index a436ec7..e932f28 100644
--- a/README.rst
+++ b/README.rst
@@ -3,14 +3,48 @@ RWA.Support.SessionService
D-Bus service, written in Python 3,
for managing sessions with Django and as a backend for GUI applications
+Getting started
+---------------
+
+Step 1: Clone repository
+^^^^^^^^^^^^^^^^^^^^^^^^
+
+Clone the source code repository via Git (sudo apt install git).
+
+>>> $ git clone https://gitlab.das-netzwerkteam.de/remotewebapp/rwa.support.sessionservice.git
+
+Step 2: Build documentation
+^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Go into the docs directory and build the html files.
+
+>>> $ cd rwa.support.sessionservice/docs
+
+Use the `Makefile` to build documentation with Sphinx.
+
+>>> $ make html
+
+You have now a bunch of HTML files in `_build/html`.
+You can make the files available via a small local webserver. We are using PHP as an example.
+
+You can also just open the `_build/html/index.html` file in your browser (if your browser is allowed to access those files).
+
+>>> $ php -S localhost:8080 -t "_build/html"
+
+Step 3: Follow installation instructions there
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+http://localhost:8080/admin/01_installation.html
+
+
Licence
-------
::
- Copyright © 2020, 2021 Jonathan Weth <dev@jonathanweth.de>
- Copyright © 2020 Mike Gabriel <mike.gabriel@das-netzwerkteam.de>
- Copyright © 2020 Daniel Teichmann <daniel.teichmann@das-netzwerkteam.de>
+ Copyright © 2020-2023 Jonathan Weth <dev@jonathanweth.de>
+ Copyright © 2020-2023 Mike Gabriel <mike.gabriel@das-netzwerkteam.de>
+ Copyright © 2020-2023 Daniel Teichmann <daniel.teichmann@das-netzwerkteam.de>
Licenced under the GPL, version 2.0 or later