Skip to content
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

Update README.md #13

Merged
merged 2 commits into from
Dec 18, 2024
Merged

Update README.md #13

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
147cb15
Update README.md
WT-MM Nov 25, 2024
46bb601
Merge branch 'master' into WT-MM-patch-1
WT-MM Dec 18, 2024
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
14 changes: 13 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,10 +31,22 @@ 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)


To save trace logs to a file, pass the `--log` flag:
```bash
cargo run --features stub -- --log
```


## Contributing
- Use `cargo fmt --all` to format the code.
Expand Down
Loading