Skip to content

Latest commit

 

History

History
76 lines (57 loc) · 2.89 KB

README.md

File metadata and controls

76 lines (57 loc) · 2.89 KB
Raw

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:

  1. Clone the repo
  2. Make the changes and update your clone
  3. Follow the "Building the docs" section to render the documentation site locally
  4. 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

  1. Make sure you have Python and pip installed 
    python --version
pip --version

!!! 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.

  1. Install MkDocs

    pip install mkdocs

  2. Install MkDocs-Material

    pip install mkdocs-material

  3. Install PyMdown Extensions

    pip install pymdown-extensions

  4. Install mkdocs-git-revision-date

    pip install mkdocs-git-revision-date-plugin

  5. Install mkdocs-macros

    pip install mkdocs-macros-plugin

  6. Build the site

    mkdocs build

  7. The documentation will be built to the site directory; preview any changes with MkDocs' built-in dev-server before submitting a pull request

    mkdocs 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