From 98615b86516f1bb008bf02377a4cf7d209048154 Mon Sep 17 00:00:00 2001 From: Kali Kaneko Date: Tue, 3 Oct 2017 18:14:52 +0200 Subject: [docs] add link to hacking section --- README.rst | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) (limited to 'README.rst') diff --git a/README.rst b/README.rst index 4b456203..b8a11d18 100644 --- a/README.rst +++ b/README.rst @@ -97,7 +97,7 @@ Hacking ----------------------------------------------------------- In order to run bitmask in a development environment, you must activate a -virtualenv and install the various packages using 'pip install -e'. This +virtualenv and install the various packages using `pip install -e`. This installs python packages as links to the source code, so that your code changes are immediately reflected in the packages installed in the virtualenv. @@ -118,8 +118,10 @@ you can run:: inside your virtualenv, and it will install any new version of your dependencies that is found in pypi. -Checkout the ``docs/hacking`` sections for more advanced instructions to get -you started. +Check out the ``docs/hacking`` sections for more extense instructions `to get +you started`_. + +.. _`to get you started`: https://bitmask.readthedocs.io/en/latest/hacking/ License -- cgit v1.2.3