Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
WT-MM authored Nov 25, 2024
1 parent 30ab8d3 commit 147cb15
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,17 @@ You can specify logging levels for individual modules by adding `module_name=log
RUST_LOG=debug,krec=warn cargo run --features stub
```

### List of features (--features / -F flag)
Features are how you specify the specific platform to run K-OS on (e.g. -F kos-kbot when running on K-Bot)
- kos-kbot
- zeroth-01 (not finished)
- sim (not finished)

## Adding a new embodiment
Reference the existing platforms / features in [platforms](platforms).

You essentially create another package (Cargo.toml, lib.rs, etc) with the necessary actuator and imu implementations according to the specifications in [kos-core](kos-core/src/services)

## Contributing
- Use `cargo fmt --all` to format the code.
- Use `cargo clippy` to check for lint errors.
Expand Down

0 comments on commit 147cb15

Please sign in to comment.