libretro/docs
Fork: 473 Star: 263 (更新于 2024-12-20 07:31:12)
license: MIT
Language: TeX .
This is a repo of the RetroArch official document page.
Contribute to the documentation
These docs are written in Markdown. If you need help with the syntax, use this guide. Mkdocs uses some Markdown extensions that you may have to familiarize with.
The documentation source is maintained via Git. For more info on how to use git, refer to Github's help page.
In order to propose improvements to a document:
- Clone the repo
- Make the changes and update your clone
- Follow the "Building the docs" section to render the documentation site locally
- Propose your changes using the button
New Pull Request
in the docs repo
There is a To-Do list for libretro/docs here and you can submit suggestions or issues regarding documentation at the libretro/docs issue tracker.
Building the docs
!!! Note "Building in Windows/msys2"
If you are using the standard RetroArch msys2 environment, you will need to install python with the command pacman -S python
. Next you will need to download the get-pip.py
script from the pip
bootstrap site. Finally, execute the script with the command python get-pip.py
.
-
Install MkDocs
pip install mkdocs
-
Install MkDocs-Material
pip install mkdocs-material
-
Install PyMdown Extensions
pip install pymdown-extensions
-
Install mkdocs-git-revision-date
pip install mkdocs-git-revision-date-plugin
-
Install mkdocs-macros
pip install mkdocs-macros-plugin
-
Build the site
mkdocs build
-
The documentation will be built to the
site
directory; preview any changes with MkDocs' built-in dev-server before submitting a pull requestmkdocs serve
References
Adding a new core
These are the documents that should be added/updated when a new core is added to the libretro ecosystem.
- Add the core to docs/library/ (Follow the latest core template. docs/meta/core-template.md)
- Add the core to mkdocs.yml
- Add the core to docs/meta/core-list.md
- Add the core to docs/meta/see-also.md if it's related to another core in some way
- Add the core to docs/development/licenses.md
- Add the core to docs/guides/softpatching.md if it supports softpatching
- Add the core to docs/guides/retroachievements.md if it supports cheevos
- Add the core to docs/library/bios.md if it needs a BIOS
最近版本更新:(数据更新于 2024-10-12 08:44:18)
libretro/docs同语言 TeX最近更新仓库
2024-09-02 05:41:36 joaomlourenco/novathesis
2023-10-20 03:18:52 premAI-io/state-of-open-source-ai
2023-05-27 17:21:19 stone-zeng/fduthesis
2021-06-10 11:18:46 narashimaraja/RVCE-Latex-Project-Report-Template
1970-01-01 00:00:00 linhduongtuan/BKHN-Thesis_template_typst
1970-01-01 00:00:00 Ttopiac/CSCI3104_Recitation101_Spring23