diff options
| author | Kali Kaneko <kali@leap.se> | 2017-10-06 22:55:33 +0200 |
|---|---|---|
| committer | Kali Kaneko <kali@leap.se> | 2017-10-06 22:55:33 +0200 |
| commit | bc62c7f492420c13705d5bd8f4061b4a5d3fd6fd (patch) | |
| tree | f694dcb21405769ea66f8f5a96ed98dec341d98f | |
| parent | 6cf1d033d2821f4d29274bbb284356bcc6146154 (diff) | |
[docs] explain how to enter the virtualenv
| -rw-r--r-- | README.rst | 12 |
1 files changed, 10 insertions, 2 deletions
@@ -66,6 +66,8 @@ in the system):: bitmaskctl logs send +but do not upload anything that you do not want to make public ;) + Development =========================================================== @@ -106,10 +108,16 @@ 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 try:: +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``:: + + pew workon bitmask + To upgrade regularly the python dependencies installed inside your virtualenv, you can run:: @@ -118,7 +126,7 @@ you can run:: inside your virtualenv, and it will install any new version of your dependencies that is found in pypi. -Check out the ``docs/hacking`` sections for more extense instructions `to get +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/ |