Add notes on development install to README

Closes gh-177
pypa · May 3, 2018 · 58e8eaf · 58e8eaf
1 parent af5b62e
commit 58e8eaf
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 1 deletion.
diff --git a/README.rst b/README.rst
@@ -68,3 +68,17 @@ Flit packages a single importable module or package at a time, using the import
 name as the name on PyPI. All subpackages and data files within a package are
 included automatically.
 
+Development
+-----------
+
+To install the development version of Flit from Github::
+
+    git clone https://github.com/takluyver/flit.git
+    cd flit
+    python3 -m pip install docutils requests
+    python3 -m flit install
+
+You may want to use the ``--symlink`` or ``--pth-file`` options so you can test
+changes without reinstalling it.
+
+To run the tests, run ``py.test``.
diff --git a/doc/index.rst b/doc/index.rst
@@ -7,7 +7,8 @@ Flit |version|
 
 .. include:: ../README.rst
 
-Contents:
+Documentation contents
+----------------------
 
 .. toctree::
    :maxdepth: 2