1 files changed, 75 insertions, 0 deletions
diff --git a/doc/source/installation.rst b/doc/source/installation.rst
new file mode 100644
index 0000000..ee6fadb
--- /dev/null
+++ b/doc/source/installation.rst
@@ -0,0 +1,75 @@
+
+Installation
+============
+
+You can install *bsie* via pip. BSIE comes with support for various file formats.
+For this, it needs to install many external packages. BSIE lets you control
+which of these you want to install. Note that if you choose to not install
+support for some file types, BSIE will show a warning and skip them.
+All other formats will be processed normally.
+It is recommended to install *bsie* in a virtual environment (via ``virtualenv``).
+
+To install only the minimally required software, use::
+
+    pip install --extra-index-url https://pip.bsfs.io bsie
+
+To install all dependencies, use the following shortcut::
+
+    pip install --extra-index-url https://pip.bsfs.io bsie[all]
+
+To install a subset of all dependencies, modify the extras part (``[image, preview]``)
+of the follwing command to your liking::
+
+    pip install --extra-index-url https://pip.bsfs.io bsie[image,preview]
+
+Currently, BSIE providesthe following extra flags:
+
+* image: Read data from image files.
+  Note that you may also have to install ``exiftool`` through your system's
+  package manager (e.g. ``sudo apt install exiftool``).
+* preview: Create previews from a variety of files.
+  Note that support for various file formats also depends on what
+  system packages you've installed. You should at least install ``imagemagick``
+  through your system's package manager (e.g. ``sudo apt install imagemagick``).
+  See `Preview Generator <https://github.com/algoo/preview-generator>`_ for
+  more detailed instructions.
+* features: Extract feature vectors from images.
+
+
+
+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/bsie.git
+
+You can further install *bsie* via the ususal `setuptools <https://setuptools.pypa.io/en/latest/index.html>`_ commands from your bsie source directory::
+
+    python setup.py develop
+
+For development, you also need to install some additional dependencies::
+
+    # extra packages for tests
+    pip install rdflib requests
+
+    # code style discipline
+    pip install mypy coverage pylint
+    # external type annotations for pyyaml
+    pip install types-PyYAML
+
+    # documentation
+    pip install sphinx sphinx-copybutton furo
+
+    # packaging
+    pip install build
+