diff mbox

[3/4] docs: Add note about Vagrant support

Message ID 1455135273-29170-3-git-send-email-stephen.finucane@intel.com
State Accepted
Headers show

Commit Message

Stephen Finucane Feb. 10, 2016, 8:14 p.m. UTC 
Signed-off-by: Stephen Finucane <stephen.finucane@intel.com>
---
 docs/development.md | 15 +++++++++++++++
 1 file changed, 15 insertions(+)

Comments

Stephen Finucane Feb. 14, 2016, 4:29 p.m. UTC | #1 
> Signed-off-by: Stephen Finucane <stephen.finucane@intel.com>

Merged.
diff mbox

Patch

diff --git a/docs/development.md b/docs/development.md
index 12a0edc..8b46969 100644
--- a/docs/development.md
+++ b/docs/development.md
@@ -11,6 +11,20 @@  The latest version of Patchwork is available with git. To download:
 
     $ git clone git://github.com/getpatchwork/patchwork.git
 
+## Vagrant-Based Installation
+
+patchwork provides a Vagrantfile that can be used to quickly configure
+patchwork in a delopment environment. Like any Vagrant VM, you can start this
+using the `vagrant up` command:
+
+    $ cd patchwork  # the path to the repo you cloned above
+    $ vagrant up
+
+Once stacked, follow the on-screen instructions. For more information on
+Vagrant itself, please refer to the [Vagrant documentation](ref-vagrant).
+
+Alternatively, manual installation steps are provided below.
+
 ## Install Required Packages
 
 There are a number of different requirements for developing patchwork:
@@ -248,4 +262,5 @@  using the provided `dev` settings file.
 [ref-py34-pip]: http://legacy.python.org/dev/peps/pep-0453/
 [ref-sqlite-utf8]: https://www.sqlite.org/faq.html#q18
 [ref-tox]: https://tox.readthedocs.org/en/latest/
+[ref-vagrant]: https://www.vagrantup.com/docs/getting-started/
 [ref-venv]: https://virtualenv.readthedocs.org/en/latest/