From f46580f034fa6314ea2d56c89f27059d1fe90576 Mon Sep 17 00:00:00 2001
From: Chenxiong Qi <cqi@redhat.com>
Date: Aug 14 2018 04:16:54 +0000
Subject: Update README


* Instead of copying koji code into rpkg, those code had been removed
  and rpkg calls Koji API now. Hence, license description of Koji code
  is removed.

* Add more detailed content to section Contribution.

* Fix minor format issue.

Signed-off-by: Chenxiong Qi <cqi@redhat.com>

---

diff --git a/README.rst b/README.rst
index afd1219..8f18aa8 100644
--- a/README.rst
+++ b/README.rst
@@ -5,14 +5,12 @@ This is the rpkg project, which mostly is a python library for dealing with
 rpm packaging in a git source control.  pyrpkg is the base library that sites
 can subclass to create useful tools.
 
-rpkg now can work with Python 2.6, 2.7, 3.5, 3.6 and 3.7.
+rpkg works with Python 2.6, 2.7, 3.5, 3.6 and 3.7.
 
 License
 =======
 
 Unless otherwise specified, all files are licensed under GPLv2+.
-There are parts of koji code in pyrpkg/cli, those parts are licensed
-under LGPLv2(.1).  See COPYING-koji for that license statement.
 
 Installation
 ============
@@ -28,7 +26,7 @@ Install in a Fedora system::
 
     sudo dnf install python2-rpkg
 
-If Python 3 package is needed, install `python3-rpkg`.
+If Python 3 package is needed, install ``python3-rpkg``.
 
 Install in EL6 or EL7::
 
@@ -64,14 +62,33 @@ You are welcome to write patches to fix or improve rpkg. All code should work
 with Python 2.6, 2.7, and 3. Before you create a PR to propose your changes,
 make sure
 
-* to sign-off your commits by ``git commit -s``. This serves as a confirmation
-  that you have the right to submit your changes. See `Developer Certificate of
-  Origin`_ for details.
+Sign-off commit
+---------------
 
-* pass all test cases by running ``python setup.py test``.
+Make sure to sign-off your commits by ``git commit -s``. This serves as a
+confirmation that you have the right to submit your changes. See `Developer
+Certificate of Origin`_ for details.
 
 .. _Developer Certificate of Origin: https://developercertificate.org/
 
+Run Tests
+---------
+
+Before make a pull request, ensure local changes pass all test cases. There
+are two choices to run tests.
+
+* Run tests in parallel with ``detox``. Newer version of ``detox`` does not
+  support ``py26``. You can run rest of test environments::
+
+    detox -e py27,py36,py37,flake8
+
+* Run tests inside a Python environment with ``tox``::
+
+    python3 -m venv env
+    source env/bin/activate
+    pip install tox
+    tox
+
 More Information
 ================