Commit d8cddb7e authored by julian.gethmann's avatar julian.gethmann

Update README.rst

parent c3d7023c
......@@ -2,9 +2,16 @@
Cassandra
=========
You can **download the documentation** as HTML from the `Pipeline artifacts <https://git.scc.kit.edu/las-software/15-3-DataProcessing/cassandra/-/jobs/artifacts/master/browse?job=docs>`_
To install the library and scripts type the following in your Linux/macos terminal::
$ python -m pip install "git+ssh://git@git.scc.kit.edu:/las-software/15-3-DataProcessing/cassandra"
Therefore you need to have your SSH key provided to this GitLab-instance.
Documentation
-------------
You can download the documentation as HTML from the `Pipeline artifacts <https://git.scc.kit.edu/las-software/15-3-DataProcessing/cassandra/-/jobs/artifacts/master/browse?job=docs>`_
If you want or need to create the docu on your own you can find some general note about writing docu.
The docu is generated using `Sphinx <https://sphinx-doc.org>`_, is written in `ReStructuredText <https://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html>`_ and not in Markdown (like e. g. many other README files).
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment