summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorKali Kaneko <kali@leap.se>2017-10-03 18:14:52 +0200
committerKali Kaneko <kali@leap.se>2017-10-03 18:14:52 +0200
commit98615b86516f1bb008bf02377a4cf7d209048154 (patch)
treefed9d666a8b5dd338b13d5603bda057e08f3c134
parenta40191f21f4cb95c9a1e10caec0f50ec33d867f8 (diff)
[docs] add link to hacking section
-rw-r--r--README.rst8
1 files changed, 5 insertions, 3 deletions
diff --git a/README.rst b/README.rst
index 4b45620..b8a11d1 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