From 87004fa65cc4833cfdbd9a24ba149123c7020edb Mon Sep 17 00:00:00 2001 From: Matthias Baumgartner Date: Sat, 4 Mar 2023 17:05:47 +0100 Subject: documentation --- doc/source/installation.rst | 46 +++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 46 insertions(+) create mode 100644 doc/source/installation.rst (limited to 'doc/source/installation.rst') diff --git a/doc/source/installation.rst b/doc/source/installation.rst new file mode 100644 index 0000000..c7d8fba --- /dev/null +++ b/doc/source/installation.rst @@ -0,0 +1,46 @@ + +Installation +============ + +Installation +------------ + +Install *BSFS* via pip:: + + pip install --extra-index-url https://pip.bsfs.io bsfs + +This installs the `bsfs` python package as well as the `bsfs.app` command. +It is recommended to install *bsfs* in a virtual environment (via `virtualenv`). + + +License +------- + +This project is released under the terms of the 3-clause BSD License. +By downloading or using the application you agree to the license's terms and conditions. + +.. literalinclude:: ../../LICENSE + + +Source +------ + +Check out our git repository:: + + git clone https://git.bsfs.io/bsfs.git + +You can further install *bsfs* via the ususal `setuptools `_ commands from your bsfs source directory:: + + python setup.py develop + +For development, you also need to install some additional dependencies:: + + # code style discipline + pip install mypy coverage pylint + + # documentation + pip install sphinx sphinx-copybutton furo + + # packaging + pip install build + -- cgit v1.2.3