From 1be0986c7a9faa5cf24d5d91900bb0d1058ba49f Mon Sep 17 00:00:00 2001 From: Hiroki Nakayama Date: Mon, 20 Apr 2020 14:18:17 +0900 Subject: [PATCH] Update README.md --- README.md | 29 +++++++++++++++++------------ 1 file changed, 17 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 8e76b707..c2de754e 100644 --- a/README.md +++ b/README.md @@ -28,14 +28,25 @@ You can try the [annotation demo](http://doccano.herokuapp.com). Two options to run doccano: -- (Recommended) Docker Compose -- Docker +- Production +- Development -### Docker Compose +In any case, you need Docker and Docker Compose. Anyway, you need to clone the repository: ```bash $ git clone https://github.com/doccano/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/doccano/doccano.git --config core.autocrlf=input +``` + +### Production + +```bash $ docker-compose -f docker-compose.prod.yml up ``` @@ -50,11 +61,7 @@ ADMIN_PASSWORD: "password" > Note: If you want to add annotators, see [Frequently Asked Questions](./docs/faq.md) -_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/doccano/doccano.git --config core.autocrlf=input -``` + -You can setup local development environment as follows: +### Development ```bash -$ git clone https://github.com/doccano/doccano.git -$ cd doccano $ docker-compose -f docker-compose.dev.yml up ```