Skip to content

Commit 39dbc6c

Browse files
authored
Refine docs/README.md (#454)
1 parent 1b4ed66 commit 39dbc6c

File tree

1 file changed

+5
-4
lines changed

1 file changed

+5
-4
lines changed

docs/README.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,19 +2,20 @@
22

33
### How to make and test your changes
44

5-
1. Navigate to the documentation directory:
5+
1. Navigate to the project root directory:
66
```bash
7-
cd parallel_programming_course/docs
7+
cd parallel_programming_course
88
```
99

1010
2. (Optional) Create a virtual environment:
1111
```bash
1212
python3 -m venv venv
1313
```
1414

15-
3. Install the required dependencies:
15+
3. Install the required dependencies (for the projects and the docs):
1616
```bash
1717
pip install -r requirements.txt
18+
pip install -r docs/requirements.txt
1819
```
1920

2021
4. Configure the documentation build:
@@ -46,7 +47,7 @@ cmake --build build -t docs_html
4647

4748
9. Make local deployment of the changes:
4849
```bash
49-
cd _build/html
50+
cd docs/_build/html
5051
python3 -m http.server 8080
5152
```
5253

0 commit comments

Comments
 (0)