Started updating documentation
This commit is contained in:
parent
be74b92bd7
commit
802f5ba0c2
17 changed files with 248 additions and 368 deletions
|
|
@ -6,21 +6,14 @@ Install
|
|||
|
||||
Stable installation
|
||||
+++++++++++++++++++
|
||||
For most users, this is the reccommended installation method.
|
||||
For most users, the OpenFlexure Microscope software should be installed using our `pre-built Raspbian SD card image. <https://openflexure.org/projects/microscope/install>`_
|
||||
|
||||
- Run ``curl -LSs get.openflexure.org/microscope |sudo bash``
|
||||
- See the `GitLab repo <https://gitlab.com/openflexure/openflexure-microscope-cli>`_ for details.
|
||||
- Follow on-screen prompts
|
||||
|
||||
Developer and non-interactive installation
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
The installer script can pull the latest development package from our git repository, and use install into a developer environment using Poetry.
|
||||
Options also exist to run the installer without any user prompts.
|
||||
|
||||
See the `installer script GitLab repo <https://gitlab.com/openflexure/openflexure-microscope-cli>`_ for details.
|
||||
|
||||
Manual installation
|
||||
+++++++++++++++++++
|
||||
|
||||
For offline (i.e. no real microscope connected) development, a basic development server can run on any system.
|
||||
|
||||
- (Recommended) create and activate a virtual environment
|
||||
- Install non-python dependencies with ``sudo apt-get install libatlas-base-dev libjasper-dev libjpeg-dev``
|
||||
- Install `Poetry <https://github.com/sdispater/poetry>`_, clone this repo, and ``poetry install`` from inside the repo.
|
||||
|
|
@ -28,6 +21,6 @@ Manual installation
|
|||
Managing the server
|
||||
-------------------
|
||||
|
||||
Managing the server through the installer script's CLI is documented `on our website <https://openflexure.gitlab.io/projects/microscope/#managing-the-microscope-server>`_.
|
||||
Managing the server through the installer script's CLI is documented `on our website <https://openflexure.org/projects/microscope/install/#managing-the-microscope-server>`_.
|
||||
|
||||
This includes starting the server as a background service, as well as starting a development server with real-time debug logging.
|
||||
Loading…
Add table
Add a link
Reference in a new issue