diff --git a/README.md b/README.md index 267662dd3c8c990486809cda21c50b89ea11482e..a5d8aeb053304f429bef85b703914df8898ef8c2 100644 --- a/README.md +++ b/README.md @@ -32,6 +32,8 @@ Install dependencies from requirements.txt This was done at start of project, and must be repeated after all dependency changes: +TODO: Decide on whether to use pip freeze or manage requirements.txt manually. Ref e.g. [this blogpost](https://medium.com/@tomagee/pip-freeze-requirements-txt-considered-harmful-f0bce66cf895) + ```sh (venv)$ pip install "fastapi[all]" (and others) (venv)$ pip freeze > requirements.txt @@ -44,6 +46,13 @@ $ . venv/bin/activate (venv)$ deactivate ``` +### Install VIPS models +The VIPS models available will vary between deployments of VIPSCore-Python. They are installed using pip, and specified in `models.txt` - which can be considered a deployment specific addendum to `requirements.txt`. Copy `models_example.txt` to `models.txt` to get started. + +```sh +pip install -r models.txt +``` + ## Development ### Run application locally