diff --git a/doc/download.rst b/doc/download.rst new file mode 100644 index 0000000000000000000000000000000000000000..d1a685684ff17efdb6373e40853369ce1d496894 --- /dev/null +++ b/doc/download.rst @@ -0,0 +1,42 @@ +.. highlight:: none + +.. _download: + +Downloading Mutalyzer +===================== + +The Mutalyzer source code is `hosted on the LUMC GitLab server +<https://git.lumc.nl/mutalyzer/mutalyzer>`_. The recommended way to get the +Mutalyzer source code is by cloning the `Git`_ repository:: + + git clone https://git.lumc.nl/mutalyzer/mutalyzer.git + +This will give you the current development version. See below for working with +other versions. + + +Release versions +---------------- + +All Mutalyzer releases are tagged. You can run ``git tag`` to list the +available tags. Use ``git checkout <tag>`` to switch to a certain release. For +example, to swith to the `2.0.0` release:: + + git checkout v2.0.0 + +Alternatively, you can checkout the `release` branch. This branch always +points to the latest Mutalyzer release. + + +Archive downloads +----------------- + +If for whatever reason you don't want to use Git, you can download the source +code directly as a zip archive or tarball. The current development version can +be found from the `project homepage +<https://git.lumc.nl/mutalyzer/mutalyzer>`_. Archive downloads for release +versions can be found on the `tags page +<https://git.lumc.nl/mutalyzer/mutalyzer/tags>`_. + + +.. _Git: http://git-scm.com/ diff --git a/doc/index.rst b/doc/index.rst index 1c641b04a22fb6e59495333d4dd6277e1bc8a5d0..5edf66fa2d6d65d6df47bc8d9d10b738d5b4ad5a 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -16,6 +16,7 @@ Information for getting Mutalyzer running on a system. .. toctree:: :maxdepth: 2 + download install config run diff --git a/doc/install.rst b/doc/install.rst index 23fd680551340c9fe2e6c6cfc4f3e0d46feb5088..a3444dc457263181dea365a89eafe3a3a5b77196 100644 --- a/doc/install.rst +++ b/doc/install.rst @@ -100,7 +100,7 @@ covered here. Assuming you created and activated a virtual environment for Mutalyzer, install all required Python packages:: - $ sudo apt-get install python-dev libmysqlclient-dev + $ sudo apt-get install python-dev libmysqlclient-dev libxml2-dev libxslt-dev $ pip install -r requirements.txt Now might be a good time to run the unit tests:: diff --git a/doc/run.rst b/doc/run.rst index 269ba126463dc50ea060c1ef3bd72233183d8fbc..e6dec44900b5731736b21bedff69487844c8b9d6 100644 --- a/doc/run.rst +++ b/doc/run.rst @@ -5,6 +5,9 @@ Running Mutalyzer ================= +Please make sure Mutalyzer can find its configuration file, as detailed in +:ref:`config`. + Mutalyzer comes with a number of different interfaces, of which the website is perhaps the main one. It can be started using a built-in test server that's useful for development and debugging purposes like this::