From 8a12d89ffc52a804b52f00c4369f4f6bc1b854c5 Mon Sep 17 00:00:00 2001 From: Joel Collins Date: Tue, 19 Mar 2019 16:59:29 +0000 Subject: [PATCH] Updated documentation for installation --- docs/source/quickstart.rst | 25 ++++++++++++++++++++----- 1 file changed, 20 insertions(+), 5 deletions(-) diff --git a/docs/source/quickstart.rst b/docs/source/quickstart.rst index a018efee..6a0c8062 100644 --- a/docs/source/quickstart.rst +++ b/docs/source/quickstart.rst @@ -4,21 +4,36 @@ Quickstart Install ------- -Auto-installer -++++++++++++++ +Quick-installer ++++++++++++++++ +For most users, this is the reccommended installation method. + - Run ``curl -LSs get.openflexure.org/microscope |sudo bash`` - See the `GitLab repo `_ for details. - Follow on-screen prompts -Manual -++++++ +Really-quick installer +^^^^^^^^^^^^^^^^^^^^^^ +The installer script can run with all default settings applied, removing all user prompts. + +- Run ``curl -LSs get.openflexure.org/microscope |sudo bash -s -- -y`` + +Developer installer +^^^^^^^^^^^^^^^^^^^ +The installer script can pull the latest development package from our git repository, and use install into a developer environment using Poetry. + +- Run ``curl -LSs get.openflexure.org/microscope |sudo bash -s -- -d`` + + +Manual installation ++++++++++++++++++++ - (Recommended) create a virtual environment - ``pip3 install virtualenv`` - ``mkdir ~/.openflexure`` - ``python3 -m virtualenv ~/.openflexure/envmicroscope`` - Activate with ``source /.openflexure/envmicroscope/bin/activate`` - Install non-python dependencies with ``sudo apt-get install libatlas-base-dev libjasper-dev libjpeg-dev`` -- **Users:** Install module by running ``pip install openflexure-microscope==1.0.0b7`` +- **Users:** Install module by running ``pip install openflexure-microscope`` - **Developers:** Install `Poetry `_, clone this repo, and ``poetry install`` from inside the repo. API Server