Skip to content

Create documentation for adding new features #3

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.

Sign up for GitHub

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

Merged
jmahmood merged 1 commit into from
Nov 17, 2025
Merged

Create documentation for adding new features #3

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
25 changes: 19 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -231,17 +231,30 @@ cargo test -p cardio_core -- --nocapture

### Adding Custom Movements

Edit `cardio_core/src/catalog.rs`:
Krep supports adding new exercises, stretches, and mobility drills. For comprehensive instructions, see:

**📖 [Adding Exercises Guide](docs/ADDING_EXERCISES.md)**

This guide covers:
- Adding simple movements (mobility drills, stretches)
- Creating movements with automatic progression
- Working with metrics and movement styles
- Multi-block workouts (circuits, complexes)
- Custom progression algorithms
- Testing and validation

**Quick Example** - Add a mobility drill:

```rust
// In cardio_core/src/catalog.rs
movements.insert(
"jump_rope".into(),
"ankle_cars".into(),
Movement {
id: "jump_rope".into(),
name: "Jump Rope".into(),
kind: MovementKind::Cardio,
id: "ankle_cars".into(),
name: "Ankle CARs".into(),
kind: MovementKind::MobilityDrill,
default_style: MovementStyle::None,
tags: vec!["vo2".into()],
tags: vec!["mobility".into(), "ankle".into()],
reference_url: Some("https://...".into()),
},
);
Expand Down
Loading
Loading