From c660ff4f699b4a192242d37ecd4c20e6d5d6585a Mon Sep 17 00:00:00 2001 From: KSLHacks Date: Wed, 23 Oct 2019 14:47:45 -0400 Subject: [PATCH 1/4] Fixing typos and formatting consistency. --- README.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 2b4a85f5..60bcb95c 100644 --- a/README.md +++ b/README.md @@ -70,7 +70,7 @@ Doccano can be deployed to AWS ([Cloudformation](https://docs.aws.amazon.com/AWS - Python 3.6+ - Django 2.1.7+ - Node.js 8.0+ -- Google Chrome(highly recommended) +- Google Chrome (highly recommended) ## Installation @@ -83,13 +83,13 @@ cd doccano To install doccano, there are three options: -**Option1: Pull the production Docker image** +#### Option 1: Pull the production Docker image ```bash docker pull chakkiworks/doccano ``` -**Option2: Setup Python environment** +#### Option 2: Setup Python environment First we need to install the dependencies. Run the following commands: @@ -110,7 +110,7 @@ npm run build cd .. ``` -**Option3: Pull the development Docker-Compose images** +#### Option 3: Pull the development Docker-Compose images ```bash docker-compose pull @@ -122,7 +122,7 @@ docker-compose pull Let’s start the development server and explore it. -Depending on your installation method, there are two options: +Depending on your installation method, there are three options: #### Option 1: Running the Docker image as a Container @@ -196,7 +196,7 @@ There is no project created yet. To create your project, make sure you’re in t Project Creation -In this step, you can select three project types: text classificatioin, sequence labeling and sequence to sequence. You should select a type with your purpose. +In this step, you can select three project types: text classification, sequence labeling and sequence to sequence. You should select a type with your purpose. ### Import Data @@ -207,8 +207,8 @@ After creating a project, you will see the "Import Data" page, or click `Import You can upload the following types of files (depending on project type): - `Text file`: file must contain one sentence/document per line separated by new lines. -- `CSV file`: file must contain a header with `"text"` as the first column or be one-column csv file. If using labels the sencond column must be the labels. -- `Excel file`: file must contain a header with `"text"` as the first column or be one-column excel file. If using labels the sencond column must be the labels. Supports multiple sheets as long as format is the same. +- `CSV file`: file must contain a header with `"text"` as the first column or be one-column csv file. If using labels the second column must be the labels. +- `Excel file`: file must contain a header with `"text"` as the first column or be one-column excel file. If using labels the second column must be the labels. Supports multiple sheets as long as format is the same. - `JSON file`: each line contains a JSON object with a `text` key. JSON format supports line breaks rendering. > Notice: Doccano won't render line breaks in annotation page for sequence labeling task due to the indent problem, but the exported JSON file still contains line breaks. From 557ef6af7bbd9e0927061ddf1c386f561e9513cc Mon Sep 17 00:00:00 2001 From: KSLHacks Date: Wed, 23 Oct 2019 14:56:21 -0400 Subject: [PATCH 2/4] Adding relevant info in Option 3 and header divide --- README.md | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 60bcb95c..1f87a76b 100644 --- a/README.md +++ b/README.md @@ -182,7 +182,14 @@ We can use docker-compose to set up the webpack server, django server, database, docker-compose up ``` -Now, open a Web browser and go to . You should see the login screen: +_Note the superuser account credentials located in the `docker-compose.yaml` file:_ +```yml +ADMIN_USERNAME: "admin" +ADMIN_PASSWORD: "password" +``` + +### Confirm all doccano services are running +Open a Web browser and go to . You should see the login screen: Login Form From c76bd1ff12ee5a87e972ddf69aed31d808f4f878 Mon Sep 17 00:00:00 2001 From: KSLHacks Date: Wed, 23 Oct 2019 15:09:31 -0400 Subject: [PATCH 3/4] Adding installation note for Windows machines. --- README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/README.md b/README.md index 1f87a76b..12b80ca3 100644 --- a/README.md +++ b/README.md @@ -81,6 +81,12 @@ git clone https://github.com/chakki-works/doccano.git cd doccano ``` +_Note for Windows developers: Be sure to configure git to correctly handle line endings or you may encounter `status code 127` errors while running the services in future steps. Running with the git config options below will ensure your git directory correctly handles line endings._ + +```bash +git clone https://github.com/chakki-works/doccano.git --config core.autocrlf=input +``` + To install doccano, there are three options: #### Option 1: Pull the production Docker image From 6e4690d706b6e94f68feb0a4394c17e4d59f2722 Mon Sep 17 00:00:00 2001 From: KSLHacks Date: Wed, 23 Oct 2019 15:40:16 -0400 Subject: [PATCH 4/4] Adding headers for readability. --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index 12b80ca3..eed55eaa 100644 --- a/README.md +++ b/README.md @@ -74,6 +74,8 @@ Doccano can be deployed to AWS ([Cloudformation](https://docs.aws.amazon.com/AWS ## Installation +### Clone repository + First of all, you have to clone the repository: ```bash @@ -87,6 +89,8 @@ _Note for Windows developers: Be sure to configure git to correctly handle line git clone https://github.com/chakki-works/doccano.git --config core.autocrlf=input ``` +### Install doccano + To install doccano, there are three options: #### Option 1: Pull the production Docker image