search

pygame-community / pygame-ce

🐍🎮 pygame - Community Edition is a FOSS Python library for multimedia applications (like games). Built on top of the excellent SDL library.
https://pyga.me
766 stars 120 forks source link

docs: README.md probably outdated #2958

Closed twistios closed 3 days ago

twistios commented 3 days ago

In the file README.md in the docs-folder, Chapter "Generating the Documentation", it says that one should run

python buildconfig/make_docs.py

The folder buildconfig does not exist. I guess the file is outdated.

oddbookworm commented 3 days ago

Just double checking, you're running that in the root of the repository after you clone it right? image

twistios commented 3 days ago

Oh, my bad, I got this issue because I was using this (new?) Pycharm feature that allows running commands from the README.md-file.

twistios commented 3 days ago

Maybe it should be added that one has to be in the main directory in the file?

oddbookworm commented 3 days ago

Maybe it should be added that one has to be in the main directory in the file?

Generally commands like that are assumed to be from the root of the repository unless specifically otherwise stated