From a361c70d189c582111744b9bae89e1933fd3e3da Mon Sep 17 00:00:00 2001 From: tomolopolis Date: Wed, 25 Mar 2020 18:05:48 +0000 Subject: [PATCH] Update README.md --- README.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index decb3adb..8ebcb4af 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@ MedCATTrainer is an interface for building, improving and customising a given Na MedCATTrainer was presented at EMNLP/IJCNLP 2019 :tada: [here](https://www.aclweb.org/anthology/D19-3024.pdf) -## Developer Guide +## Installation Guide 1\. Clone the repo: @@ -18,7 +18,7 @@ MedCATTrainer was presented at EMNLP/IJCNLP 2019 :tada: `$ docker-compose -f docker-compose-dev.yml build` If the build fails with an error code 137, the virtual machine running the docker -daemon does not have enough memory. Adjust in docker daemon settings CLI or associated docker GUI. +daemon does not have enough memory. Increase the allocated memory to containers in the docker daemon settings CLI or associated docker GUI. `$ docker-compose -f docker-compose-dev.yml up` @@ -68,6 +68,8 @@ a given project) can be added via the django admin UI.**   5\. To upload documents and begin annotating, you'll first need to create a project via the admin page: http://localhost:8001/admin/. +## User Guide + ### Create an Annotation Project Using the admin page, a configured superuser can create, edit and delete annotation projects.