Add a bit of light documentation for using Vagrant
authorMatt Palmer <mpalmer@hezmatt.org>
Mon, 14 Sep 2015 05:49:08 +0000 (15:49 +1000)
committerMatt Palmer <mpalmer@hezmatt.org>
Mon, 14 Sep 2015 05:49:08 +0000 (15:49 +1000)
README.md

index efdea970da01498435e3da12f15b38d5462edd55..9c3904c5bf73da58d6156d375a0fab5414360796 100644 (file)
--- a/README.md
+++ b/README.md
@@ -177,6 +177,23 @@ installs you can ensure they are in sync by looking at `/etc/passwd` and
 - [Linking containers for a multiple container setup](https://meta.discourse.org/t/linking-containers-for-a-multiple-container-setup/20867)
 - [Replace rubygems.org with taobao mirror to resolve network error in China](https://meta.discourse.org/t/replace-rubygems-org-with-taobao-mirror-to-resolve-network-error-in-china/21988/1)
 
+### Developing with Vagrant
+
+If you are looking to make modifications to this repository, you can easily test
+out your changes before committing, using the magic of
+[Vagrant](http://vagrantup.com).  Install Vagrant as per [the default
+instructions](http://docs.vagrantup.com/v2/installation/index.html), and
+then run:
+
+    vagrant up
+
+This will spawn a new Ubuntu VM, install Docker, and then await your
+instructions.  You can then SSH into the VM with `vagrant ssh`, become
+`root` with `sudo -i`, and then you're right to go.  Your live git repo is
+already available at `/var/discourse`, so you can just `cd /var/discourse`
+and then start running `launcher`.
+
+
 License
 ===
 MIT