README and CHANGELOG

1 files changed, 50 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..08707d3
--- /dev/null
+++ b/README.md
@@ -0,0 +1,50 @@
+
+tagit - the BSFS browser
+========================
+
+## Installation
+
+You can install tagit via pip:
+
+    $ pip install --extra-index-url https://pip.bsfs.io tagit
+
+
+## Development
+
+Set up a virtual environment:
+
+    $ virtualenv env
+    $ source env/bin/activate
+
+Install tagit as editable from the git repository:
+
+    $ git clone https://git.bsfs.io/tagit.git
+    $ cd tagit
+    $ pip install -e .
+
+Install the following additional packages besides tagit:
+
+    $ pip install coverage mypy pylint
+    $ pip install sphinx sphinx-copybutton sphinxcontrib-video furo
+    $ pip install build
+
+To ensure code style discipline, run the following commands:
+
+    $ coverage run ; coverage html ; xdg-open .htmlcov/index.html
+    $ pylint tagit
+    $ mypy
+
+To build the package, do:
+
+    $ python -m build
+
+To run only the tests (without coverage), run the following command from the **test folder**:
+
+    $ python -m unittest
+
+To build the documentation, run the following commands from the **doc folder**:
+
+    $ make html
+    $ xdg-open build/html/index.html
+
+