Coppersource/gm0 ↗
Created Feb 18, 2021 · View the Coppersource/gm0 repository page
Game Manual 0 - The most extensive guide out there for FTC
Want this for your repo?
Render a free sample of any GitHub repo in seconds.
Contributors
19
Lines of Code
4,775
From
Aug 16, 2019
To
Feb 16, 2021
About Coppersource/gm0
Game Manual 0 is an extensive educational resource for the FIRST Tech Challenge (FTC) robotics competition. It serves as a comprehensive guide for teams participating in FTC, covering various aspects of the competition and robotics engineering. The project is community-driven and maintained through an open-source model, allowing multiple contributors to expand and improve the documentation over time.
The repository uses Sphinx, a popular Python-based documentation generator, to build the source material written in reStructuredText format. This approach enables the documentation to be compiled into multiple output formats including HTML for web viewing and LaTeX PDF for offline reading. The project includes development tools for quality assurance, such as linting to validate documentation structure and link checking to ensure all references are current.
To support local development, the project provides an autobuild feature that watches for file changes and automatically rebuilds the documentation, allowing contributors to preview their changes in real-time through a local development server. The build process requires Python 3 along with several system dependencies including TexLive for PDF generation, dvipng for image rendering, and graphviz for diagram generation.