From b6e5145f713d5ac15dd8929b5afec3a97a31a697 Mon Sep 17 00:00:00 2001 From: Camila Macedo Date: Mon, 18 Sep 2023 18:28:29 +0100 Subject: [PATCH] (readme): small fix and add notes to help out new users - Correct the command for executing the requirements. - Include two notes to guide new users and prevent potential issues. --- README.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 6e10501a0..5a70871ae 100644 --- a/README.md +++ b/README.md @@ -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 run `pip3 install -r requirements.txt`, restart your terminal or use source to ensure Sphinx is set up. ### Using Virtualenv to Provide Requirements @@ -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.