summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorKali Kaneko <kali@leap.se>2017-10-06 23:03:19 +0200
committerKali Kaneko <kali@leap.se>2017-10-06 23:03:19 +0200
commit74b5170876958d6440b709a33b5f450518c6b683 (patch)
treefb8245775bf5f7bf65f7d995d91ab7bdfd12b2a0
parentbc62c7f492420c13705d5bd8f4061b4a5d3fd6fd (diff)
[docs] add some links to the readme
-rw-r--r--README.rst21
1 files changed, 12 insertions, 9 deletions
diff --git a/README.rst b/README.rst
index 634d9a69..259c1c91 100644
--- a/README.rst
+++ b/README.rst
@@ -98,23 +98,23 @@ More info abou testing can be found in the ``docs/hacking/testing`` document.
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
-installs python packages as links to the source code, so that your code
-changes are immediately reflected in the packages installed in the
-virtualenv.
+In order to run bitmask in a development environment, you must activate a
+`virtualenv`_ and install the various leap-related python packages using ``pip
+install -e``. This installs them as links to the source code, so
+that your code changes are immediately reflected in the packages imported from
+within the virtualenv.
The various ``make dev-*`` commands will run the appropriate ``pip install``
commands for you.
-If you want to setup your whole development environment, and you are running a
-debian-based system, you can use::
+If you want to setup your whole development environment in a single step, and
+you are running a debian-based system, you can use::
make dev-bootstrap
That should install all the system dependencies, create a virtualenv for you,
and drop you in a shell inside that virtualenv. In the future, you can enter this
-virtualenv again by using ``pew``::
+`virtualenv`_ again by using `pew`_::
pew workon bitmask
@@ -124,12 +124,15 @@ you can run::
make upgrade-all
inside your virtualenv, and it will install any new version of your
-dependencies that is found in pypi.
+dependencies that is found in `pypi`_.
Check out the ``docs/hacking`` page for more extense instructions `to get
you started`_.
.. _`to get you started`: https://bitmask.readthedocs.io/en/latest/hacking/
+.. _`pew`: https://pypi.python.org/pypi/pew
+.. _`virtualenv`: https://pypi.python.org/pypi/virtualenv
+.. _`pypi`: https://pypi.python.org
License