From 6caa8493bc6dfbfcb6e39fa6cc0fb531939bf7b5 Mon Sep 17 00:00:00 2001 From: Stephen Finucane Date: Thu, 28 Jan 2016 11:34:17 +0000 Subject: docs: Add a README 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 --- README.md | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) create mode 100644 README.md 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 -- cgit v1.2.3