diff --git a/README.md b/README.md index acb4fd60..8f02cfc5 100644 --- a/README.md +++ b/README.md @@ -9,6 +9,10 @@ This includes basic installation instructions suitable for most users. Full developer documentation can be found on [**ReadTheDocs**](https://openflexure-microscope-software.readthedocs.io/en/stable/). This includes installing the server in a mode better suited for active development. +## Installation +* `poetry install` +* `poetry run build` + ## Build-system As of 1.0.0b0, we're using [Poetry](https://github.com/sdispater/poetry) to manage dependencies, build, and distribute the package. All package information and dependencies are found in `pyproject.toml`, in line with [PEP 518](https://www.python.org/dev/peps/pep-0518/). If you're developing this package, make use of `poetry.lock` to ensure you're using the latest locked dependency list.