diff options
| author | Stephen Finucane <stephen.finucane@intel.com> | 2016-02-10 19:50:42 +0000 |
|---|---|---|
| committer | Stephen Finucane <stephen.finucane@intel.com> | 2016-02-10 20:12:39 +0000 |
| commit | 6d9417e2bea2c39a165e54c3b2db8ae4a2d3c8f5 (patch) | |
| tree | b6ae5f8af95221e5d70dbfd719b390bc8d855d55 /docs | |
| parent | 6def775af3a727ace056be7de4df8fce35458536 (diff) | |
| download | patchwork-6d9417e2bea2c39a165e54c3b2db8ae4a2d3c8f5.tar patchwork-6d9417e2bea2c39a165e54c3b2db8ae4a2d3c8f5.tar.gz | |
docs: Add note about Vagrant support
Signed-off-by: Stephen Finucane <stephen.finucane@intel.com>
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/development.md | 15 |
1 files changed, 15 insertions, 0 deletions
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/ |