diff mbox

[1/7] docs: Add a README

Message ID 1454534555-17582-1-git-send-email-stephen.finucane@intel.com
State Accepted
Headers show

Commit Message

Stephen Finucane Feb. 3, 2016, 9:22 p.m. UTC 
This is mostly a copy/paste of 'index.md' with added badges. This will
be useful to provide an overview to people who stumble upon patchwork
on GitHub.

Signed-off-by: Stephen Finucane <stephen.finucane@intel.com>
---
 README.md | 30 ++++++++++++++++++++++++++++++
 1 file changed, 30 insertions(+)
 create mode 100644 README.md

Comments

Stephen Finucane Feb. 5, 2016, 5:43 p.m. UTC | #1 
On 03 Feb 21:22, Stephen Finucane wrote:
> This is mostly a copy/paste of 'index.md' with added badges. This will
> be useful to provide an overview to people who stumble upon patchwork
> on GitHub.
> 
> Signed-off-by: Stephen Finucane <stephen.finucane@intel.com>

Trivial enough with clear usability improvements. Merged.
diff mbox

Patch

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..87509ed
--- /dev/null
+++ b/README.md
@@ -0,0 +1,30 @@ 
+# patchwork
+
+[![Requirements Status][badge-req-img]][badge-req-ref]
+[![Docs Status][badge-doc-img]][badge-doc-ref]
+
+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.
+
+Patches that have been sent to a mailing list are 'caught' by the system, and
+appear on a web page. Any comments posted that reference the patch are appended
+to the patch page too. The project's maintainer can then scan through the list
+of patches, marking each with a certain state, such as Accepted, Rejected or
+Under Review. Old patches can be sent to the archive or deleted.
+
+Currently, patchwork is being used for a number of open-source projects, mostly
+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.
+
+# Additional Information
+
+For further information, please refer to the [docs][docs].
+
+[docs]: https://patchwork.readthedocs.org/en/latest/
+[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