Code Monkey home page Code Monkey logo

srobo-runbook's Introduction

Student Robotics Volunteer Runbook

GitHub Actions

The runbook aims to be a single source for all Student Robotics internal documentation. This includes information for the Competition Team and Kit Team, as well as other activities.

Installation

To run this project locally, you'll need:

  • Python (>=3.6, <3.12)
  • pip

Usage

Installing dependencies

It's recommended to use a virtual environment:

python -m venv env

env\Scripts\activate.bat  # on windows
source env/bin/activate  # on macOS / Linux

Then, install dependencies:

pip install -r requirements.txt

Running development server

mkdocs serve

This will launch a server on http://localhost:8000. Content in the server will live-reload as changes are made. If large refactors of the site structure are made, it's advisable to stop the server, make the changes, then restart it.

Production build

mkdocs build

This will build the site once, and place it in site/ in the root of the project. This may be useful to see which files are rendered, and how exactly to access them.

Spell checking

This project uses CSpell for spell checking. Plugins are available for a variety of editors and a command line runner is available through npm:

npm install
npm run spell-check

Words that CSpell is unaware of can be added to the .spelling file.

License

This work is licensed under the Creative Commons Attribution-ShareAlike 4.0 International License. To view a copy of this license, visit http://creativecommons.org/licenses/by-sa/4.0/ or send a letter to Creative Commons, PO Box 1866, Mountain View, CA 94042, USA.

srobo-runbook's People

Contributors

adimote avatar antoinepetty avatar bedfordsean avatar dependabot[bot] avatar elisabethzues avatar fgillan avatar gitbook-bot avatar jcwilliamson avatar jmorse avatar peterjclaw avatar prophile avatar raccube avatar realorangeone avatar rgilton avatar richardbarlow avatar scarzy avatar sedders123 avatar thomas-strafrac avatar thomasleese avatar trickeydan avatar tyler-ward avatar willb97 avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.