aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorMatthias Baumgartner <dev@igsor.net>2023-03-05 19:16:22 +0100
committerMatthias Baumgartner <dev@igsor.net>2023-03-05 19:16:22 +0100
commit5e88d395dee651175a277092c712249e3898a7d8 (patch)
treee6e0b475c7ab5c6a7ff4f0ea7ad1b08cecf05e68 /doc
parent54c1f6f845765fa7ed8720bbbc0130d99fc7a123 (diff)
downloadtagit-5e88d395dee651175a277092c712249e3898a7d8.tar.gz
tagit-5e88d395dee651175a277092c712249e3898a7d8.tar.bz2
tagit-5e88d395dee651175a277092c712249e3898a7d8.zip
build fixes
Diffstat (limited to 'doc')
-rw-r--r--doc/source/installation.rst23
1 files changed, 22 insertions, 1 deletions
diff --git a/doc/source/installation.rst b/doc/source/installation.rst
index 87ecff0..12d8898 100644
--- a/doc/source/installation.rst
+++ b/doc/source/installation.rst
@@ -7,7 +7,7 @@ Install *tagit* via pip::
pip install --extra-index-url https://pip.bsfs.io tagit
This installs the `tagit` python package as well as the `tagit.app` command.
-It is recommended to install *tagit* in a virtual environment (via `virtualenv`).
+It is recommended to install *tagit* in a virtual environment (via ``virtualenv``).
Please note that you may have to separately install the `BSIE <https://www.bsfs.io/bsie>`_
package into the same environment.
@@ -21,6 +21,27 @@ By downloading or using the application you agree to the license's terms and con
.. literalinclude:: ../../LICENSE
+Demo
+----
+
+The following commands install *tagit*, its dependencies, and the demo files,
+then starts *tagit*. Of course, you can also do this in a ``virtualenv``::
+
+ pip install --extra-index-url https://pip.bsfs.io/ tagit
+ wget https://www.bsfs.io/demo/tagitrc -O ~/.tagitrc
+ wget https://www.bsfs.io/demo/demo-triples.pkl -O ~/demo-triples.pkl
+ wget https://www.bsfs.io/demo/demo-schema.pkl -O ~/demo-schema.pkl
+ tagit
+
+Or, you can run the demo in a docker container (although it will be relatively slow)::
+
+ mkdir bsfs-demo; cd bsfs-demo
+ wget https://www.bsfs.io/demo/Dockerfile
+ docker build -t bsfs/demo .
+ xhost +local:*
+ docker run --rm --ipc=host -e DISPLAY -v /tmp/.X11-unix/:/tmp/.X11-unix -it bsfs/demo
+
+
Source
------