build fixes

1 files changed, 37 insertions, 4 deletions

diff --git a/README.md b/README.md
index 85cb68f..eee19f7 100644
--- a/README.md
+++ b/README.md
@@ -7,10 +7,38 @@ that information in a BSFS storage.
 
 ## Installation
 
-You can install BSIE via pip:
+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.
+
+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.
+
 
 ## Development
 
@@ -23,9 +51,15 @@ Install bsie as editable from the git repository:
 
     $ git clone https://git.bsfs.io/bsie.git
     $ cd bsie
-    $ pip install -e .
+    $ pip install -e .[all]
+
+If you want to develop (*dev*), run the tests (*test*), edit the
+documentation (*doc*), or build a distributable (*build*),
+install bsfs with the respective extras (in addition to file format extras):
 
-Install the following additional packages besides BSIE:
+    $ pip install -e .[dev,doc,build,test]
+
+Or, you can manually install the following packages besides BSIE:
 
     $ pip install coverage mypy pylint
     $ pip install rdflib requests types-PyYAML
@@ -52,4 +86,3 @@ To build the documentation, run the following commands from the **doc folder**:
     $ make html
     $ xdg-open build/html/index.html
 
-