docker
/
docs
mirror of https://github.com/docker/docs.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update contributing guide for Windows dev 

Please read over Windows section for prereqs.
This commit is contained in:
Michael Chiang 2015-06-16 21:04:48 -07:00
parent 2149720664
commit 44b484531b
1 changed files with 11 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
CONTRIBUTING.md
View File

@ -15,17 +15,20 @@ Before you fil an issue or a pull request, quickly read of the following tips on
- [Testing](#testing) - [Testing](#testing)
- [License](#license) - [License](#license)
### Prerequisites
### Prerequisites for developing Kitematic on Mac
You will need to install:
- [Node.js 0.10.38](https://nodejs.org/dist/v0.10.38/)
- The latest Xcode from the Apple App Store.
### Prerequisites for developing Kitematic on on Windows
You will need to install:
- [Node.js 0.10.38](https://nodejs.org/dist/v0.10.38/) - [Node.js 0.10.38](https://nodejs.org/dist/v0.10.38/)
- Open a command prompt (`cmd`) and run the command `mkdir ~/AppData/Roaming/npm`
### Other Prerequisites (Mac) - [Visual Studio 2013 Community](https://www.visualstudio.com/en-us/products/visual-studio-community-vs.aspx) (or similar) - You do not need to install any optional packages during install.
- The latest Xcode from the Apple App Store.
### Other Prerequisites (Windows)
- [Visual Studio 2013 Community](https://www.visualstudio.com/en-us/products/visual-studio-community-vs.aspx) (or similar) - Kitematic does not need any optional packages.
- [Python](https://www.python.org/downloads/release/python-2710/) - [Python](https://www.python.org/downloads/release/python-2710/)
### Getting Started ### Getting Started
- `npm install` - `npm install`
@ -34,7 +37,7 @@ To run the app in development:
- `npm start` - `npm start`
Running `npm start` will download and install the OS X Docker client, Running `npm start` will download and install the Docker client,
[Docker Machine](https://github.com/docker/machine), [Docker Compose](https://github.com/docker/compose) [Docker Machine](https://github.com/docker/machine), [Docker Compose](https://github.com/docker/compose)
the [Boot2Docker iso](https://github.com/boot2docker/boot2docker), the [Boot2Docker iso](https://github.com/boot2docker/boot2docker),
[Electron](http://electron.atom.io/). [Electron](http://electron.atom.io/).