[devtools] Create a general README

Message ID 20190322224533.6677-1-jelle@vdwaa.nl
State Accepted
Headers show
Series
  • [devtools] Create a general README
Related show

Commit Message

Jelle van der Waa March 22, 2019, 10:45 p.m. UTC
Introduce a README which describes where to send patches and how to
release a new version of devtools.

Signed-off-by: Jelle van der Waa <jelle@vdwaa.nl>
---
 README.md | 24 ++++++++++++++++++++++++
 1 file changed, 24 insertions(+)
 create mode 100644 README.md

Patch

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..7c6764e
--- /dev/null
+++ b/README.md
@@ -0,0 +1,24 @@ 
+# Devtools - development tools for Arch Linux
+
+This repository contains tools for the Arch Linux distribution for building
+and maintaining official repository packages.
+
+## Patches
+
+Patches can be send to arch-projects@archlinux.org or via a pull request on
+Github. When sending patches to the mailing list make sure to set a valid
+subjectprefix otherwise the email is denied by mailman. Git can be configured
+as following.
+
+```
+git config format.subjectprefix 'devtools] [PATCH'
+```
+
+## Releasing
+
+1. bump the version in the Makefile
+2. Commit everything as  ```Version $(date + "%Y%m%d")```
+3. Create a new tag ```git tag -s $(date +"%Y%m%d")```
+4. Push changes
+5. Upload the source tarball with ```make dist upload```
+6. Update the package