Skip to content

Commit

Permalink
add notes to the readme to help out new users
Browse files Browse the repository at this point in the history
  • Loading branch information
camilamacedo86 committed Sep 18, 2023
1 parent ed24314 commit 18992cf
Showing 1 changed file with 7 additions and 1 deletion.
8 changes: 7 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,9 @@ Before beginning any work, review the [contributing section](#contributing).

To build the documentation, python3 and `pip3` are required.
All required python modules are listed in `requirements.txt`.
Install them with `pip install -r requirements.txt`.
Install them with `pip3 install -r requirements.txt`.

📌 NOTE: After pip3 install -r requirements.txt, restart your terminal or use source to ensure Sphinx is set up.

### Using Virtualenv to Provide Requirements

Expand All @@ -40,6 +42,10 @@ $ make html

```

📌 **NOTE:** When you fork this project, make sure to disable the option that allows forking of only the main branch.
If you overlook this step, you may encounter issues when executing the make html command, as you will be required to
specify the value via the environment variables `MP_UPDATE_VERSION`.

You can then open `build/html/index.html` in your browser to view the
documentation.

Expand Down

0 comments on commit 18992cf

Please sign in to comment.