Skip to content

Commit 52cdf9e

Browse files
Add documentation
1 parent 99e3fef commit 52cdf9e

File tree

2 files changed

+12
-0
lines changed

2 files changed

+12
-0
lines changed

README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -150,6 +150,12 @@ Next we need to create a user who can login to the admin site. Run the following
150150
python manage.py create_admin --noinput --username "admin" --email "[email protected]" --password "password"
151151
```
152152

153+
Create the admin, annotator, and annotation approver roles to assign to users. Run the following command:
154+
155+
```bash
156+
python manage.py create_roles
157+
```
158+
153159
Developers can also validate that the project works as expected by running the tests:
154160

155161
```bash
@@ -235,6 +241,12 @@ Click `Labels` button in left bar to define your own labels. You should see the
235241

236242
<img src="./docs/label_editor.png" alt="Edit label" width=600>
237243

244+
### Assign Roles to Users
245+
246+
Click `Users` button in left bar to assign project users to annotator, admin, or annotation approval roles.
247+
248+
<img src="./docs/user_page.png" alt="Edit label" width=600>
249+
238250
### Annotation
239251

240252
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.

docs/user_page.png

167 KB
Loading

0 commit comments

Comments
 (0)