From 24e404849dd64aa010ac5742d2dafcf6ef815b42 Mon Sep 17 00:00:00 2001
From: Adam Miller <maxamillion@fedoraproject.org>
Date: Feb 08 2017 16:06:01 +0000
Subject: add docs about how flr is released


Signed-off-by: Adam Miller <maxamillion@fedoraproject.org>

---

diff --git a/README.rst b/README.rst
index 5485f18..d36e305 100644
--- a/README.rst
+++ b/README.rst
@@ -106,6 +106,33 @@ matter if they are on this list or not.
 * `Patrick Uiterwijk`_
 * `Adam Miller`_
 
+Releases
+========
+
+Releases are managed by `git tag`_ and tarballs can be downloaded from the
+`release location`_ provided by `pagure`_.
+
+How Releases Are Prepared
+-------------------------
+
+For developers working on flr that want to cut a release or for those who are
+curious how releases are done, the following is the process.
+
+In the example below we are releasing the ``0.0.2`` version.
+
+::
+
+    $ git checkout master
+
+    $ git tag 0.0.2
+
+    $ git push --tags
+
+    $ git archive --format=tar.gz --prefix=flr-0.0.2/ 0.0.2 > /tmp/flr-0.0.2.tar.gz
+
+
+The resulting file ``/tmp/flr-0.0.2.tar.gz`` would then be uploaded using the
+``Pagure Release Page``.
 
 .. _pytest: http://pytest.org/
 .. _Fedora: https://getfedora.org/
@@ -117,5 +144,9 @@ matter if they are on this list or not.
 .. _Patrick Uiterwijk: https://fedoraproject.org/wiki/User:Puiterwijk
 .. _Adam Miller: https://fedoraproject.org/wiki/User:Maxamillion
 .. _FAS: https://fedoraproject.org/wiki/Account_System
+.. _git tag: https://git-scm.com/book/en/v2/Git-Basics-Tagging
+.. _pagure: https://pagure.io/pagure
+.. _release location: https://releases.pagure.org/flr
+.. _Pagure Release Page: https://pagure.io/flr/releases
 .. _topic branch:
     https://git-scm.com/book/en/v2/Git-Branching-Branching-Workflows#Topic-Branches