Updated readme

=====================

# Installation

## Easy

- Run `curl -LSs get.openflexure.org/microscope |sudo bash`

- Follow on-screen prompts

## Manual

### User

- (Recommended) create a virtual environment

    - Create a virtual environment with `python3 -m venv env` (or your favourite virtual environment system)

    - Activate with `source env/bin/activate`

  - `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`

- Install module by running `pip install openflexure-microscope==1.0.0b5`

- **Users:** Install module by running `pip install openflexure-microscope==1.0.0b5`

- **Developers:** Install [Poetry](https://github.com/sdispater/poetry), clone this repo, and `poetry install` from inside the repo.

# Usage

## Running the web API in Gunicorn (port 5000)

- Ensure Gunicorn is installed to the current environment (`pip install gunicorn`)

- Run `gunicorn --threads 5 --workers 1 --bind 0.0.0.0:5000 openflexure_microscope.api.app:app`

- Run `gunicorn --threads 5 --workers 1 --graceful-timeout 2 --bind 0.0.0.0:5000 --log-level=debug openflexure_microscope.api.app:app`

# REST(ish) API

The Flask app serves a (reasonably) RESTful web API. For most user-facing functionality, this is the preferred interface.