Skip to content

Commit b42c5cb

Browse files
[docs] Improved development installation instructions order
1 parent cff1f2b commit b42c5cb

File tree

1 file changed

+25
-11
lines changed

1 file changed

+25
-11
lines changed

docs/developer/installation.rst

+25-11
Original file line numberDiff line numberDiff line change
@@ -27,37 +27,39 @@ Install spatialite and sqlite:
2727
Installing for Development
2828
--------------------------
2929

30-
Fork and clone the forked repository:
30+
Create project directory:
3131

3232
.. code-block:: shell
3333
34-
git clone git://github.com/<your_fork>/openwisp-firmware-upgrader
34+
mkdir openwisp && cd openwisp
3535
36-
Navigate into the cloned repository:
36+
The directory structure will look like this:
3737

38-
.. code-block:: shell
38+
.. code-block:: text
3939
40-
cd openwisp-firmware-upgrader/
40+
openwisp/ # Main project folder
41+
├── env/ # Virtual environment
42+
└── openwisp-firmware-upgrader/ # Cloned repository
4143
42-
Launch Redis:
44+
Fork and clone the forked repository:
4345

4446
.. code-block:: shell
4547
46-
docker-compose up -d redis
48+
git clone git://github.com/<your_fork>/openwisp-firmware-upgrader
4749
48-
Install test requirements:
50+
Navigate into the cloned repository:
4951

5052
.. code-block:: shell
5153
52-
pip install -r requirements-test.txt
54+
cd openwisp-firmware-upgrader/
5355
5456
Setup and activate a virtual-environment (we'll be using `virtualenv
5557
<https://pypi.org/project/virtualenv/>`_):
5658

5759
.. code-block:: shell
5860
59-
python -m virtualenv env
60-
source env/bin/activate
61+
python -m virtualenv ../env
62+
source ../env/bin/activate
6163
6264
Make sure that your base python packages are up to date before moving to
6365
the next step:
@@ -66,6 +68,18 @@ the next step:
6668
6769
pip install -U pip wheel setuptools
6870
71+
Install test requirements:
72+
73+
.. code-block:: shell
74+
75+
pip install -r requirements-test.txt
76+
77+
Launch Redis:
78+
79+
.. code-block:: shell
80+
81+
docker-compose up -d redis
82+
6983
Install development dependencies:
7084

7185
.. code-block:: shell

0 commit comments

Comments
 (0)