Update README.md
This commit is contained in:
parent
428e3e01c5
commit
a325115c09
1 changed files with 3 additions and 24 deletions
27
README.md
27
README.md
|
|
@ -1,35 +1,14 @@
|
||||||
OpenFlexure Microscope Software
|
OpenFlexure Microscope Software
|
||||||
=====================
|
=====================
|
||||||
|
|
||||||
# Installation
|
# Quickstart
|
||||||
|
|
||||||
A general user-guide on setting up your microscope can be found [here on our website](https://www.openflexure.org/projects/microscope/).
|
A general user-guide on setting up your microscope can be found [**here on our website**](https://www.openflexure.org/projects/microscope/).
|
||||||
|
|
||||||
## Easy
|
## Installation
|
||||||
- Run `curl -LSs get.openflexure.org/microscope |sudo bash`
|
- Run `curl -LSs get.openflexure.org/microscope |sudo bash`
|
||||||
- Follow on-screen prompts
|
- Follow on-screen prompts
|
||||||
|
|
||||||
## Manual
|
|
||||||
### User
|
|
||||||
- (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`
|
|
||||||
- **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 --graceful-timeout 3 --bind 0.0.0.0:5000 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.
|
|
||||||
API documentation, with example requests, is available [here](https://openflexure-microscope-software.readthedocs.io/en/latest/api.html).
|
|
||||||
|
|
||||||
|
|
||||||
# Developer notes
|
# Developer notes
|
||||||
|
|
||||||
## Documentation
|
## Documentation
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue