Skip to content

Commit

Permalink
Updated documents and shifted wordings
Browse files Browse the repository at this point in the history
  • Loading branch information
agoeden12 committed Dec 1, 2023
1 parent 7735be8 commit 68ae721
Show file tree
Hide file tree
Showing 8 changed files with 25 additions and 66 deletions.
1 change: 0 additions & 1 deletion .github/README.md

This file was deleted.

58 changes: 13 additions & 45 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,58 +2,26 @@

This repository contains the development pages and official document for the Autonomous Karting Series Competition Rules. The individual sections of the rules have a folder with a markdown file for development and discussion purposes. The official document will be a protected latex file that requires approval to edit and modify.

- [Autonomous Karting Series Rulebook](#autonomous-karting-series-rulebook)
- [Administrative](#administrative)
- [What is the competition](#what-is-the-competition)
- [Who is allowed to compete](#who-is-allowed-to-compete)
- [Required Roles](#required-roles)
- [Documentation Requirements from teams](#documentation-requirements-from-teams)
- [Jurisdiction of rules](#jurisdiction-of-rules)
- [Electrical](#electrical)
- [Software](#software)
- [Mechanical](#mechanical)
- [Safety](#safety)
- [Race Procedure](#race-procedure)
- [Appendix](#appendix)
**Development Rulebook can be seen [here](https://rules.autonomouskartingseries.com/)**

## Administrative
## Commands

### What is the competition
For full documentation visit [mdbook](https://rust-lang.github.io/mdBook/).

The Autonomous Karting Series is a collegiate competition series in which teams design, build, and race autonomous electric go-karts.
* `mdbook serve --open` - Start the live-reloading docs server.
* `mdbook build` - Build the documentation site.
* `mdbook help` - Print a help message.

### Who is allowed to compete
## [Administrative](src/Administrative/administrative.md)

1. Teams are required to be affiliated with an Academic Institution.
2. A team can consist of members from more than one University, however any one person cannot be on multiple teams.
## [Electrical](src/Electrical/electrical.md)

### Required Roles
## [Software](src/Software/software.md)

1. All teams must establish at least one member as their Autonomous Safety Officer.
* The Autonomous Safety Office will ensure that their team’s kart is operating in a safe manner on and off track.
2. All teams must establish at least one Designated Driver.
* A Designated Driver is a separate person from a team’s Autonomous Safety Officer.
* A Designated Driver is responsible for driving the team’s kart as either a driver within the kart or when the kart is being operated remotely.
## [Mechanical](src/Mechanical/mechanical.md)

### Documentation Requirements from teams
1. All participants must sign and submit a liability waiver.
1. All teams must submit the required videos and design documentation before specified race deadlines.
2. Some events may require certain components and features to be demonstrated in person.
1. Teams must be able to demonstrate all components and features in person if requested.
2. Teams will be notified of specific demonstrations before the event.
## [Safety](src/Safety/safety.md)

### Jurisdiction of rules
## [Race Procedure](src/Race_Procedure/race_procedure.md)

1. All announcements and comments posted on the official website of the competition are to be considered part of the official ruleset

## [Electrical](./Electrical/electrical.md)

## [Software](./Software/software.md)

## [Mechanical](./Mechanical/mechanical.md)

## [Safety](./Safety/safety.md)

## [Race Procedure](./Race_Procedure/race_procedure.md)

## [Appendix](./Appendix.md)
## [Appendix](src/Appendix/Appendix.md)
5 changes: 5 additions & 0 deletions src/Administrative/administrative.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,3 +20,8 @@

## Jurisdiction of rules
1. All announcements and comments posted on the official website of the competition are to be considered part of the official ruleset

## Disclaimer

These rules are open to interpretation where specifics are not given. This means that, for example, a material that is stated to be banned in one section is banned in all sections except where explicitly allowed. Other sections may have exceptions that explicitly allow or disallow under specific circumstances for those sections.

5 changes: 0 additions & 5 deletions src/Electrical/electrical.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,12 @@
<!-- omit in toc -->
# Electrical Rules

- [Disclaimer](#disclaimer)
- [Drivetrain](#drivetrain)
- [Batteries](#batteries)
- [General Wiring](#general-wiring)
- [Computers and Sensors](#computers-and-sensors)
- [Design Documentation](#design-documentation)

## Disclaimer

These rules are open to interpretation where specifics are not given. This means that, for example, a material is not explicitly stated then that material is not banned as long as it does not break another rule in this section. Other sections may have specificities for those areas.

## Drivetrain

1. The __Drivetrain__ of the kart must be entirely electric.
Expand Down
5 changes: 0 additions & 5 deletions src/Mechanical/mechanical.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
# Mechanical Rules


- [Disclaimer](#disclaimer)
- [Frame / Chassis](#frame--chassis)
- [Tires](#tires)
- [Brakes](#brakes)
Expand All @@ -14,10 +13,6 @@
- [Go Kart Suppliers](#go-kart-suppliers)
- [Tires](#tires-1)

## Disclaimer

These rules are open to interpretation where specifics are not given. This means that, for example, a material is not explicitly stated then that material is not banned as long as it does not break another rule in this section. Other sections may have specificities for those areas.

## Frame / Chassis

1. Any Commercial Full Size "Sprint Kart" chassis may be used
Expand Down
5 changes: 0 additions & 5 deletions src/Race_Procedure/race_procedure.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
<!-- omit in toc -->
# Race Procedure Rules

- [Disclaimer](#disclaimer)
- [Spirit of the Competition](#spirit-of-the-competition)
- [Race Structure](#race-structure)
- [Race Track definition](#race-track-definition)
Expand All @@ -10,10 +9,6 @@
- [Reactive required category](#reactive-required-category)
- [Awards](#awards)

## Disclaimer

These rules are open to interpretation where specifics are not given. This means that, for example, a material is not explicitly stated then that material is not banned as long as it does not break another rule in this section. Other sections may have specificities for those areas.

## Spirit of the Competition

The goal of the Autonomous Karting Series is to create an accessible and exciting autonomous go kart race. The race presents a realistic scenario in which teams need to build go-karts that will race and compete on a track autonomously. It is encouraged that teams will work to create innovative and performant hardware, electrical, and software solutions.
Expand Down
5 changes: 0 additions & 5 deletions src/Safety/safety.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,13 @@
<!-- omit in toc -->
# Safety Rules

- [Disclaimer](#disclaimer)
- [Required Safety Components](#required-safety-components)
- [Remote Control](#remote-control)
- [Enforcement](#enforcement)
- [Resources](#resources)
- [Bodywork](#bodywork)
- [Long Range Control (Including Remote EStop)](#long-range-control-including-remote-estop)

## Disclaimer

These rules are open to interpretation where specifics are not given. This means that, for example, a material is not explicitly stated then that material is not banned as long as it does not break another rule in this section. Other sections may have specificities for those areas.

## Required Safety Components

1. __Remote Estop__ must be tied to at minimum a physical controller.
Expand Down
7 changes: 7 additions & 0 deletions src/Software/software.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
<!-- omit in toc -->
# Software Rules

- [**WIP**](#wip)


### **WIP**

0 comments on commit 68ae721

Please sign in to comment.