search

UPBGE / UPBGE-Docs

UPBGE Manual
https://upbge.org/docs/latest/manual/index.html
19 stars 16 forks source link

Readme change #31

Closed ShaunKulesa closed 3 years ago

ShaunKulesa commented 3 years ago

@lordloki what's your opinion on this?

## Requirements
Building is automatically done when you edit a file. To edit either create a pull request or ask for edit permission.

OR

To build this documentation on your own system, you will be required to have these dependencies installed:
- [Python 3](https://www.python.org/)
- [Sphinx](https://pypi.org/project/Sphinx/)
- [Read The Docs Theme for Sphinx](https://pypi.org/project/sphinx_rtd_theme/)

Once every dependency is installed, simply open the console on the top level directory and run the command:

`make html`

The documentation will be built in the directory **build**.
lordloki commented 3 years ago

I just modified the readme to explicit that the requirements are to build locally. I included a text to ask for commit rights if you want to modify a lot documentation. Thanks for noting. Closing the report.