Skip to content

Commit

Permalink
Add warnings about Git to installation docs
Browse files Browse the repository at this point in the history
  • Loading branch information
jwbonner committed Jan 15, 2024
1 parent 61658ab commit 98385ec
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion docs/INSTALLATION.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,9 @@ For new projects, the easiest way to use AdvantageKit is to download one of the
- **Swerve Drive Project:** Example command based project with a swerve drive and flywheel, including support for physics simulation, feedforward characterization, and PathPlanner. This projects supports the Spark Max, Spark Flex, and Talon FX.
- **Advanced Swerve Drive Project:** Identical to the "Swerve Drive Project" but with support for high-frequency odometry (e.g. 250Hz) on REV and CTRE hardware. This significantly increases complexity, but may improve the consistency of odometry measurements. More details can be found in the [announcement post](https://www.chiefdelphi.com/t/advantagekit-2024-log-replay-again/442968/54#advanced-swerve-drive-project-2).

> Note: To switch between modes, set the "mode" attribute in `Constants.java` to `REAL`, `SIM` (physics simulation), or `REPLAY`. To support the Spark Flex, replace all instances of `CANSparkMax` with `CANSparkFlex` in the Spark Max IO implementations (the changes to the API do not impact these projects).
To switch between modes, set the "mode" attribute in `Constants.java` to `REAL`, `SIM` (physics simulation), or `REPLAY`. To support the Spark Flex, replace all instances of `CANSparkMax` with `CANSparkFlex` in the Spark Max IO implementations (the changes to the API do not impact these projects).

> Note: Git must be installed to build the example projects. See [here](https://git-scm.com/downloads) for installation instructions.
## Existing Projects

Expand Down Expand Up @@ -129,3 +131,5 @@ You should also add the `BuildConstants.java` file to the repository `.gitignore
```
src/main/java/frc/robot/BuildConstants.java
```

> Note: Git must be installed and available on the PATH to use the Gversion plugin. See [here](https://git-scm.com/downloads).

0 comments on commit 98385ec

Please sign in to comment.