Browse Source

Add documentation

pull/333/head
margaretmeehan 5 years ago
parent
commit
52cdf9ee46
2 changed files with 12 additions and 0 deletions
  1. 12
      README.md
  2. BIN
      docs/user_page.png

12
README.md

@ -150,6 +150,12 @@ Next we need to create a user who can login to the admin site. Run the following
python manage.py create_admin --noinput --username "admin" --email "admin@example.com" --password "password"
```
Create the admin, annotator, and annotation approver roles to assign to users. Run the following command:
```bash
python manage.py create_roles
```
Developers can also validate that the project works as expected by running the tests:
```bash
@ -235,6 +241,12 @@ Click `Labels` button in left bar to define your own labels. You should see the
<img src="./docs/label_editor.png" alt="Edit label" width=600>
### Assign Roles to Users
Click `Users` button in left bar to assign project users to annotator, admin, or annotation approval roles.
<img src="./docs/user_page.png" alt="Edit label" width=600>
### Annotation
Now, you are ready to annotate the texts. Just click the `Annotate Data` button in the navigation bar, you can start to annotate the documents you uploaded.

BIN
docs/user_page.png

Before After
Width: 2566  |  Height: 1032  |  Size: 167 KiB
Loading…
Cancel
Save