Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

(readme): small fix and add notes to help out new users #597

Merged
merged 1 commit into from
Sep 19, 2023
Merged

(readme): small fix and add notes to help out new users #597

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,9 @@

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

Expand All @@ -40,6 +42,10 @@

```

📌 **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

Check warning on line 46 in README.md

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[Fio-docs.sentence-length] Aim for sentences no longer than 25 words

Raw Output:
{"message": "[Fio-docs.sentence-length] Aim for sentences no longer than 25 words", "location": {"path": "README.md", "range": {"start": {"line": 46, "column": 1}}}, "severity": "INFO"}
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
Loading