docs/README.md
Hedonium 0678a8392f Update README.md
- Add contributing guide to README.
2018-04-27 11:06:21 -04:00

1.1 KiB

Libretro Documentation

This is the source for the libretro documentation, powered by MkDocs.

MkDocs documentation

Material for MkDocs documentation

Libretro Forums topic

Contributing guide

To-do list

travis

Building

  1. Make sure you have Python and pip installed

    python --version
    pip --version
    
  2. Install MkDocs

    pip install mkdocs
    
  3. Install MkDocs-Material

    pip install mkdocs-material
    
  4. Install PyMdown Extensions

    pip install pymdown-extensions
    
  5. Build the site

    mkdocs build
    
  6. The documentation will be built to the site directory