Skip to content

Commit

Permalink
📝 Updated docs
Browse files Browse the repository at this point in the history
  • Loading branch information
ThatXliner committed Oct 1, 2024
1 parent 64a53fb commit bfef9ed
Showing 1 changed file with 37 additions and 1 deletion.
38 changes: 37 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ A cute pink circular turret bot, competing at CalGames 2024.

Since we're using AdvantageKit, we follow the [IO-layer](https://github.com/Mechanical-Advantage/AdvantageKit/blob/main/docs/RECORDING-INPUTS.md)-based, [command-based](https://docs.wpilib.org/en/stable/docs/software/commandbased/index.html), project structure [similar to MechanicalAdvantage](https://github.com/Mechanical-Advantage/RobotCode2022/tree/main/src/main/java/frc/robot/subsystems).

The dependencies we use are (besides [WPILIB](https://docs.wpilib.org/en/stable/index.html)):
The dependencies we use are (besides [WPILib](https://docs.wpilib.org/en/stable/index.html)):

- [AdvantageKit](https://github.com/Mechanical-Advantage/AdvantageKit): logging library (saved to file)
- [Monologue](https://github.com/shueja/Monologue): also a logging library, but for sending things to NT for the dashboard
Expand All @@ -18,6 +18,42 @@ The dependencies we use are (besides [WPILIB](https://docs.wpilib.org/en/stable/

Other than the typical FRC code structure scaffold, we also have GitHub Actions and some scripts to help with deployment.

## How to

### ...start developing??

```shell
git clone https://github.com/Team3256/Kirby_Bot_2024.git
cd Kirby_Bot_2024
# if any of these commands fail, you either
# installed WPILib incorrectly
# or you didn't add ~/wpilib/2024/jdk/bin
./gradlew wrapper
./gradlew build
# or, if you want to simulate teh code
./gradlew simulateJava
```

### ...run the formatter?

```shell
./gradlew spotlessApply
```

## ...generate controller maps?

```shell
./gradlew spotlessApply
# Go to NetworkTables > NetworkTables View > Transitory Values >
# /AdvantageKit/RealOutputs/controllerMap
python scripts/gen_controller_map.py
# Now, open the index.html
# (`open` is a macOS-only command)
open scripts/index.html
```

After installing

## Style guide

We use Spotless for formatting (run `./gradlew spotlessApply`) and follow [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/).
Expand Down

0 comments on commit bfef9ed

Please sign in to comment.