Skip to content
/ gm0 Public
forked from gamemanual0/gm0

Game Manual 0 - The most extensive guide out there for FTC

License

Notifications You must be signed in to change notification settings

seakrueger/gm0

This branch is 14 commits ahead of, 24 commits behind gamemanual0/gm0:main.

Folders and files

NameName
Last commit message
Last commit date

Latest commit

8b0454a · Nov 18, 2023
Apr 28, 2023
Nov 2, 2023
Nov 13, 2022
Oct 26, 2023
Nov 18, 2023
Oct 24, 2023
Oct 26, 2023
Jul 16, 2020
Jul 24, 2022
Aug 1, 2022
Jul 24, 2022
May 23, 2023
Nov 13, 2022

Repository files navigation

Game Manual 0

Docs Badge CI Badge Link Check

Welcome to Game Manual 0 (gm0)! This repository contains the source of Game Manual 0.

Building Game Manual 0

Game Manual 0 employs the Sphinx documentation generator, and the articles themselves are written in reStructuredText.

Requirements

  • Python 3
  • TexLive
  • dvipng
  • graphviz
  • make

Ensure the Python requirements are installed via running python3 -m pip install -r source/requirements.txt.

Building

How to check if the documentation is valid:

  • make lint (note: on Windows, make winlint will ignore CRLF line ending errors)
  • make linkcheck

How to build the different versions of the documentation:

  • make html
  • make latexpdf

How to see the options for building:

  • make help

How to develop the website:

  • Run make autobuild
  • This will set up a file watcher and build on file changes. A development server is served at http://127.0.0.1:8000 by default. Go to your preferred browser and open that URL to view your local development version of gm0.

About

Game Manual 0 - The most extensive guide out there for FTC

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Python 48.4%
  • HTML 20.8%
  • Shell 13.1%
  • CSS 5.4%
  • Makefile 5.4%
  • Batchfile 3.6%
  • Other 3.3%