Skip to content

FIRSTRobotics/fms-manual

Repository files navigation

CI docs

fms-manual

Welcome to fms-manual! This repository contains the underlying articles for the official User Manual and guide for Scorekeepers working FIRST Robotics Competition events. This project is licensed under Creative Commons, with assets such as the FIRST logo under trademark and copyright of FIRST. This project is managed by the FRC Global Scorekeepers. For questions or comments, please contact FIRST HQ.

Contributions are welcome! See CONTRIBUTING.md for details.

The website is available under the following domains:

Building

The quickest way to build and preview the manual locally is with Docker — no need to install Python or LaTeX:

docker compose up docs

Then open http://localhost:8000. Editing any file under source/ rebuilds the site and refreshes your browser automatically. See CONTRIBUTING.md for more, including the link check and PDF builds.

To build without Docker, install:

  • Python 3.12
  • LaTeX, only if building the PDF (see MiKTeX for Windows)
  • Python dependencies in source/requirements.txt

Then build by running make html.

Styleguide

Styleguide is duplicate of frc-docs

In case of conflict with the official FRC Game Manual- the Game Manual is the official source.

About

FMS Manual

Resources

License

Contributing

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors