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 <SvenDowideit@docker.com>
This commit is contained in:
Sven Dowideit 2015-05-13 16:28:27 +10:00
parent 5c0dba6b07
commit 0aff11d4a3
1 changed files with 12 additions and 0 deletions

View File

@ -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`