From 58e8eaf224c11c5ad4bb7ff06350f95989bbb867 Mon Sep 17 00:00:00 2001 From: Thomas Kluyver Date: Thu, 3 May 2018 09:45:11 +0200 Subject: [PATCH] Add notes on development install to README Closes gh-177 --- README.rst | 14 ++++++++++++++ doc/index.rst | 3 ++- 2 files changed, 16 insertions(+), 1 deletion(-) diff --git a/README.rst b/README.rst index 0b430826..b758bd1d 100644 --- 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 index 8e1043d0..5583cbcf 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -7,7 +7,8 @@ Flit |version| .. include:: ../README.rst -Contents: +Documentation contents +---------------------- .. toctree:: :maxdepth: 2