From 44b484531b1204a75d5b4d2804faef63b8023b56 Mon Sep 17 00:00:00 2001 From: Michael Chiang Date: Tue, 16 Jun 2015 21:04:48 -0700 Subject: [PATCH] Update contributing guide for Windows dev Please read over Windows section for prereqs. --- CONTRIBUTING.md | 19 +++++++++++-------- 1 file changed, 11 insertions(+), 8 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 584230bba6..f38aa4bd51 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -15,17 +15,20 @@ Before you fil an issue or a pull request, quickly read of the following tips on - [Testing](#testing) - [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/) - -### Other Prerequisites (Mac) -- 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. +- Open a command prompt (`cmd`) and run the command `mkdir ~/AppData/Roaming/npm` +- [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. - [Python](https://www.python.org/downloads/release/python-2710/) + ### Getting Started - `npm install` @@ -34,7 +37,7 @@ To run the app in development: - `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) the [Boot2Docker iso](https://github.com/boot2docker/boot2docker), [Electron](http://electron.atom.io/).