Skip to content
This repository was archived by the owner on Mar 23, 2021. It is now read-only.

Commit 2d04d44

Browse files
Update README with Windows instructions
1 parent 5d90dea commit 2d04d44

File tree

1 file changed

+27
-5
lines changed

1 file changed

+27
-5
lines changed

README.md

Lines changed: 27 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,35 @@ Set up a local development environment for COMIT apps with one command.
66

77
If you have any question please [reach out to the team in our Gitter chat](https://gitter.im/comit-network/community)!
88

9-
## 1 - Install
9+
## 1 - Install docker
1010

11-
1. Install Docker,
12-
2. Install [yarn](https://yarnpkg.com/lang/en/docs/install/),
13-
3. Run `yarn create comit-app --help`.
11+
### Unix
12+
13+
Install docker through your package manager.
14+
Make sure the unix-socket of the docker daemon is accessible.
15+
16+
### Windows
17+
18+
Windows users have the choice between Docker Toolbox (the "old" docker) and Docker for Windows (the "new" docker).
19+
Docker for Windows requires Windows 10 Pro, whereas Docker Toolbox also works on older versions of Windows and Windows 10 Home.
20+
21+
#### Docker Toolbox
22+
23+
Install Docker Toolbox and start the virtual machine.
24+
Double check that the environment variables `DOCKER_HOST`, `DOCKER_CERT_PATH` and `DOCKER_TLS_VERIFY` have been set.
25+
26+
#### Docker for Windows
27+
28+
To use create-comit-app with Docker for Windows please follow these steps:
29+
30+
1. Set the `DOCKER_HOST` variable to the docker daemon endpoint. You can find that in the docker control panel, should be something like `tcp://127.0.0.1:2375`.
31+
2. Disable the TLS verification of the docker daemon endpoint: In your docker control panel: Settings > General > Expose daemon on tcp... without TLS
32+
33+
## 2 - Install yarn & nodeJS
34+
35+
Install them either from the website or through your package manager.
1436

15-
## 2 - Create your first project!
37+
## 3 - Create your first project!
1638

1739
1. `yarn create comit-app new <your-app-name>`,
1840
2. `cd <your-app-name>` and `yarn start-env` to start blockchain and COMIT nodes,

0 commit comments

Comments
 (0)