Skip to content

Commit c660ff4

Browse files
committed
Fixing typos and formatting consistency.
1 parent 59b8564 commit c660ff4

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ Doccano can be deployed to AWS ([Cloudformation](https://docs.aws.amazon.com/AWS
7070
- Python 3.6+
7171
- Django 2.1.7+
7272
- Node.js 8.0+
73-
- Google Chrome(highly recommended)
73+
- Google Chrome (highly recommended)
7474

7575
## Installation
7676

@@ -83,13 +83,13 @@ cd doccano
8383

8484
To install doccano, there are three options:
8585

86-
**Option1: Pull the production Docker image**
86+
#### Option 1: Pull the production Docker image
8787

8888
```bash
8989
docker pull chakkiworks/doccano
9090
```
9191

92-
**Option2: Setup Python environment**
92+
#### Option 2: Setup Python environment
9393

9494
First we need to install the dependencies. Run the following commands:
9595

@@ -110,7 +110,7 @@ npm run build
110110
cd ..
111111
```
112112

113-
**Option3: Pull the development Docker-Compose images**
113+
#### Option 3: Pull the development Docker-Compose images
114114

115115
```bash
116116
docker-compose pull
@@ -122,7 +122,7 @@ docker-compose pull
122122

123123
Let’s start the development server and explore it.
124124

125-
Depending on your installation method, there are two options:
125+
Depending on your installation method, there are three options:
126126

127127
#### Option 1: Running the Docker image as a Container
128128

@@ -196,7 +196,7 @@ There is no project created yet. To create your project, make sure you’re in t
196196

197197
<img src="./docs/create_project.png" alt="Project Creation" width=400>
198198

199-
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.
199+
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.
200200

201201
### Import Data
202202

@@ -207,8 +207,8 @@ After creating a project, you will see the "Import Data" page, or click `Import
207207
You can upload the following types of files (depending on project type):
208208

209209
- `Text file`: file must contain one sentence/document per line separated by new lines.
210-
- `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.
211-
- `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.
210+
- `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.
211+
- `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.
212212
- `JSON file`: each line contains a JSON object with a `text` key. JSON format supports line breaks rendering.
213213

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

0 commit comments

Comments
 (0)