diff --git a/README.md b/README.md new file mode 100644 index 0000000..0e4c61b --- /dev/null +++ b/README.md @@ -0,0 +1,37 @@ +# RancherOS Vagrant + +Quickly checkout RancherOS using Vagrant/Virtualbox. + + +## Getting started +1.) Install dependencies + +* Virtualbox (Tested with 4.3.22) +* Vagrant (Tested with 1.7.2) + +2.) Clone this project + +``` +git clone https://github.com/rancherio/os-vagrant.git +cd os-vagrant +``` + +3.) Up and Running + +``` +vagrant up +vagrant ssh +``` + +Start running Docker like you usually would! + + +### Customizing and configuring + + +To get a feel for how things work under the hood checkout the +[RancherOS Repo](https://github.com/rancherio/os) for details. + + + +