summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorStephen Finucane <stephen.finucane@intel.com>2016-02-25 10:47:25 +0000
committerStephen Finucane <stephen.finucane@intel.com>2016-02-26 19:55:26 +0000
commitd3858508c4a609a744e997726bb5f52544de810d (patch)
tree01614574db0ab1f3a3bb73de7aaf612503d1bf87 /README.md
parent602bffd75d123215bb4d1a8643943b739e762c36 (diff)
downloadpatchwork-d3858508c4a609a744e997726bb5f52544de810d.tar
patchwork-d3858508c4a609a744e997726bb5f52544de810d.tar.gz
README: Add quickstart section for devs
Signed-off-by: Stephen Finucane <stephen.finucane@intel.com>
Diffstat (limited to 'README.md')
-rw-r--r--README.md23
1 files changed, 21 insertions, 2 deletions
diff --git a/README.md b/README.md
index ae7754d..4ba074d 100644
--- a/README.md
+++ b/README.md
@@ -4,7 +4,7 @@
[![Docs Status][badge-doc-img]][badge-doc-ref]
[![Stories in Ready][badge-waffle-img]][badge-waffle-ref]
-patchwork is a patch tracking system for community-based projects. It is
+**patchwork** is a patch tracking system for community-based projects. It is
intended to make the patch management process easier for both the project's
contributors and maintainers, leaving time for the more important (and more
interesting) stuff.
@@ -20,14 +20,33 @@ subsystems of the Linux kernel. Although Patchwork has been developed with the
kernel workflow in mind, the aim is to be flexible enough to suit the majority
of community projects.
+# Development Installation
+
+1. Install [**Vagrant**][ref-vagrant]
+2. Clone this repo:
+
+ $ git clone git://github.com/getpatchwork/patchwork.git
+
+3. Run `vagrant up`:
+
+ $ cd patchwork
+ $ vagrant up
+
# Additional Information
For further information, please refer to the [docs][docs].
-[docs]: https://patchwork.readthedocs.org/en/latest/
+# Contact
+
+For bug reports, patch submissions or other questions, please use the
+[patchwork mailing list][pw-ml].
+
[badge-doc-ref]: https://patchwork.readthedocs.org/en/latest/
[badge-doc-img]: https://readthedocs.org/projects/patchwork/badge/?version=latest
[badge-req-ref]: https://requires.io/github/getpatchwork/patchwork/requirements/?branch=master
[badge-req-img]: https://requires.io/github/getpatchwork/patchwork/requirements.svg?branch=master
[badge-waffle-ref]: https://waffle.io/getpatchwork/patchwork
[badge-waffle-img]: https://badge.waffle.io/getpatchwork/patchwork.svg?label=ready&title=Ready
+[docs]: https://patchwork.readthedocs.org/en/latest/
+[pw-ml]: https://ozlabs.org/mailman/listinfo/patchwork
+[ref-vagrant]: https://www.vagrantup.com/docs/getting-started/