From 0aff11d4a3d97340ee2a6dd562aba2b651a66e5d Mon Sep 17 00:00:00 2001 From: Sven Dowideit Date: Wed, 13 May 2015 16:28:27 +1000 Subject: [PATCH] Add info about what the pre-requisites are Need to think about minimum versions, as it upgraded some thing, but not vbox Signed-off-by: Sven Dowideit --- CONTRIBUTING.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 5270bcabfc..28e47f23d5 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -6,6 +6,7 @@ Before you fil an issue or a pull request, quickly read of the following tips on ## Table of Contents + - [Prerequisites](#prerequisites) - [Getting Started](#getting-started) - [Architecture](#architecture) - [GitHub Issues](#github-issues) @@ -14,6 +15,17 @@ Before you fil an issue or a pull request, quickly read of the following tips on - [Testing](#testing) - [License](#license) +### Prerequisites + +Most of the time, you'll have installed Kitematic before contibuting, but for the +sake of completeness, you can also install [Node.js](https://nodejs.org/) and then +run from your Git clone. + +Running `npm start` will download and install [Docker machine](https://github.com/docker/machine), +the [Boot2Docker iso](https://github.com/boot2docker/boot2docker), +[Electron](http://electron.atom.io/), and [VirtualBox](https://www.virtualbox.org/) +if needed. + ### Getting Started - `npm install`