Merge pull request #196 from crocs-muni/issue/195-Docs

Docs

1 files changed, 47 insertions, 0 deletions

diff --git a/docs/installation.md b/docs/installation.md
new file mode 100644
index 00000000..71e685db
--- /dev/null
+++ b/docs/installation.md
@@ -0,0 +1,47 @@
+# Installation
+
+::::{tab-set}
+:::{tab-item} PyPi (pip)
+
+The tool can be installed from PyPi with
+
+```bash
+pip install -U sec-certs
+```
+
+Note, that `Python>=3.8` is required.
+
+:::
+
+:::{tab-item} Docker
+
+The tool can be pulled as a docker image with
+
+```bash
+docker pull seccerts/sec-certs
+```
+
+:::
+:::{tab-item} Build from sources
+
+The stable release is also published on [GitHub](https://github.com/crocs-muni/sec-certs/releases) from where it can be setup for development with
+
+```bash
+python3 -m venv venv
+source venv/bin/activate
+pip install -e .
+```
+
+Alternatively, our Our [Dockerfile](https://github.com/crocs-muni/sec-certs/blob/main/Dockerfile) represents a reproducible way of setting up the environment.
+
+:::
+::::
+
+If you're not using Docker, you must install the dependencies as described below.
+
+## Dependencies
+
+- [Java](https://www.java.com/en) is needed to parse tables in FIPS pdf documents, must be available from `PATH`.
+- Some imported libraries have non-trivial dependencies to resolve:
+    - [pdftotext](https://github.com/jalan/pdftotext) requires [Poppler](https://poppler.freedesktop.org/) to be installed. We've experienced issues with older versions of Poppler (`0.x`), make sure to install `20.x` version of these libraries.
+    - [graphviz](https://pypi.org/project/graphviz/) requires `graphviz` to be on the path
\ No newline at end of file