diff --git a/README.md b/README.md index 8700e700..008b9473 100644 --- a/README.md +++ b/README.md @@ -24,7 +24,7 @@ Feedback, feature requests, and bug reports are welcome on the [issues page](htt Looking to get started quickly? Here are some example projects to check out: -- [AdvantageKit Example Projects](https://github.com/Mechanical-Advantage/AdvantageKit/blob/main/docs/INSTALLATION.md#new-projects) - Example projects for differential and swerve drives, from minimal to advanced. Zip files for each project are attached to the latest release +- [AdvantageKit Example Projects](https://github.com/Mechanical-Advantage/AdvantageKit/blob/main/docs/INSTALLATION.md#new-projects) - Example projects for differential and swerve drives, from minimal to advanced (including a project designed for the [2024 FIRST KitBot](https://www.firstinspires.org/resource-library/frc/kitbot)). Zip files for each project are attached to the latest release. - [Team 6328's 2023 Competition Code](https://github.com/Mechanical-Advantage/RobotCode2023) - Java robot code built with AdvantageKit v2 (2023). - [Team 2910's 2023 Competition Code](https://github.com/FRCTeam2910/2023CompetitionRobot-Public) - Java robot code built with AdvantageKit v2 (2023). - [Team 4099's 2023 Competition Code](https://github.com/team4099/ChargedUp-2023/tree/main) - Kotlin robot code built with AdvantageKit v2 (2023). diff --git a/docs/INSTALLATION.md b/docs/INSTALLATION.md index 1073e684..37056e5a 100644 --- a/docs/INSTALLATION.md +++ b/docs/INSTALLATION.md @@ -5,8 +5,9 @@ For new projects, the easiest way to use AdvantageKit is to download one of the example projects attached to the [latest release](https://github.com/Mechanical-Advantage/AdvantageKit/releases/latest). After downloading and unzipping the file, just adjust the team number in ".wpilib/wpilib_preferences.json" and get started! - **Skeleton Project:** Includes a basic `TimedRobot` style structure, which supports logging on a real robot, physics simulation, and replay in simulation. This template is ideal if you prefer to start from a minimal project. -- **Differential Drive Project:** Example command based project with an open-loop tank drive and closed-loop flywheel, including support for physics simulation and replay. -- **Swerve Drive Project:** Example command based project with a swerve drive and closed-loop flywheel, including support for physics simulation and replay. Additional features include odometry, field-oriented drive with joysticks, and auto paths with PathPlanner. +- **2024 KitBot Project:** Example command based project for the [2024 FIRST KitBot](https://www.firstinspires.org/resource-library/frc/kitbot), including support for physics simulation, SysId, and PathPlanner. +- **Differential Drive Project:** Example command based project with a tank drive and flywheel, including support for physics simulation, SysId, and PathPlanner. +- **Swerve Drive Project:** Example command based project with a swerve drive and flywheel, including support for physics simulation, SysId, and PathPlanner. - **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`. Each subsystem includes a Spark Max and Talon FX implementation. To switch to the Spark Flex, replace all instances of `CANSparkMax` with `CANSparkFlex` (the changes to the API do not impact these projects).