Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.md #57

Merged
merged 1 commit into from
Feb 12, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 10 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ A live website is available [here](https://botracer.xyz/).
To add a new race, follow these steps:

1. Fork this project
2. Modify `public/data/races.json`
2. Modify `public/data/races/<year>.json`
3. Keep the same format as this template:
```js
{
Expand All @@ -31,7 +31,15 @@ To add a new race, follow these steps:
}
}
```
5. Open a pull request
5. **The Bot name must be available in [bots.json](public/data/bots.json)**
6. **The Judge name must be available in [judges.json](public/data/judges.json)**
7. Open a pull request

### Adding a new Bot/Judge

1. Modify [bots.json](public/data/bots.json) to add a new Bot
2. Modify [judges.json](public/data/judges.json) to add a Judge bot
3. The order must be alphabetically sorted, ignoring the case

### Findings
To add a finding for your bot, follow these steps:
Expand Down
Loading