Commit b3680ad6 authored by D.H.D. Nguyen's avatar D.H.D. Nguyen
Browse files

update README

parent c69fd91b
Loading
Loading
Loading
Loading
+6 −6
Original line number Diff line number Diff line
@@ -59,7 +59,7 @@ swp/
├── config.py - Configurations
├── doc - Documentation
│   └── ...
├── examples - Example files
├── examples - Example files for tests and running application in development environment
│   ├── empty_example.txt
│   ├── example_fewer_5.txt
│   ├── first_10_characters_examples
@@ -78,7 +78,7 @@ swp/
│   ├── generator.py - Generators
│   ├── models.py - Database Models
│   ├── templates - Application Templates
│   │   ├── annotator - Tempaltes in Annotator Subsystem
│   │   ├── annotator - Templates in Annotator Subsystem
│   │   │   ├── batch.html
│   │   │   ├── index.html
│   │   │   └── project.html
@@ -107,7 +107,7 @@ swp/

#### § Short User Manual
* In order to upload a project, you need an account first. Then, follow the instructions on the website.
* For the project, upload only non-empty **_.txt_**-files. 
* For the project, upload only non-empty ``.txt``-files. 
* There are 2 options how the annotation works:
	* Option 1: Local annotator system - You should find the annotators yourself. 
	* Option 2: ***Mechanical Turk*** - The project will be created on Amazon 
@@ -174,7 +174,7 @@ swp/
    * Test validations in user registration
        * Username, email are never used before.
        * Username has no special character, meets the length requirement.
        * Email must have email format.
        * Email must have email format, meets the length requirement.
        * Password must meet the length requirement.
    * Test validations in user login
        * Not signed up username returns error.
@@ -183,9 +183,9 @@ swp/
    * There must exist at least one non-empty `txt`-file.
    * At least 5 uploaded items for the project.
    * Project description must be long enough (at least 20 characters long).
    * **Best** and **Worst** definition are not the same.
    * **Best** and **Worst** definitions are not the same.
* Test validation in annotator login
	* If keyword is already used, the pseudoname must correspond to given pseudoname before. (No 2 annotators have the same keyword)
	* If keyword is already used, the pseudoname must correspond to given pseudoname before. (2 annotators do not have the same keyword)
* Test validations in annotating a batch
	* Every field is required.
    * In a tuple, an item is not allowed to be chosen as both **Best** and **Worst**.