diff --git a/README.md b/README.md index 7a399ebd..1befce1d 100644 --- a/README.md +++ b/README.md @@ -44,24 +44,78 @@ To install doccano, simply run: $ git clone https://github.com/chakki-works/doccano.git $ cd doccano $ pip install -r requirements.txt +$ cd app ``` -create superuser. +First we’ll need to create a user who can login to the admin site. Run the following command: + ```bash -$ cd app $ python manage.py createsuperuser ``` +Enter your desired username and press enter. + +```bash +Username: admin +``` + +You will then be prompted for your desired email address: + +```bash +Email address: admin@example.com +``` + +The final step is to enter your password. You will be asked to enter your password twice, the second time as a confirmation of the first. + +```bash +Password: ********** +Password (again): ********* +Superuser created successfully. +``` + ## Usage -First, run web application: +### Start the development server + +Let’s start the development server and explore it. + +If the server is not running start it like so: ```bash $ python manage.py runserver ``` -Then, open in your browser. +Now, open a Web browser and go to . You should see the login screen: + +Login Form + +### Create a project + +Now, try logging in with the superuser account you created in the previous step. You should see the doccano project list page: + +projects + +You should see there is no project. + +To create your project, make sure you’re in the project list page and select `Create Project` button. You should see the following screen: + +Project Creation + +In project creation, you can select three project types: text classificatioin, sequence labeling and sequence to sequence. You should select a type with your purpose. + +### Import text items + +Now that we’ve created a project. Now you’re at the “dataset” page for the project. This page displays all the documents in the project. You can see there is no documents. + +To import text items, select `Import Data` button in the navigation bar. You should see the following screen: + +Upload project + + +### Define label + +### Annotation ## Contribution diff --git a/app/db.sqlite3 b/app/db.sqlite3 index f1163646..e49afea2 100644 Binary files a/app/db.sqlite3 and b/app/db.sqlite3 differ diff --git a/docs/create_project.png b/docs/create_project.png new file mode 100644 index 00000000..0e9602d7 Binary files /dev/null and b/docs/create_project.png differ diff --git a/docs/login_form.png b/docs/login_form.png new file mode 100644 index 00000000..c7ff9cf7 Binary files /dev/null and b/docs/login_form.png differ diff --git a/docs/projects.png b/docs/projects.png new file mode 100644 index 00000000..6ccab0d7 Binary files /dev/null and b/docs/projects.png differ diff --git a/docs/upload.png b/docs/upload.png new file mode 100644 index 00000000..5a2fa385 Binary files /dev/null and b/docs/upload.png differ