Skip to content

Add running examples section in README.md #6

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
teor2345 merged 2 commits into from
Jul 23, 2026
Merged

Add running examples section in README.md #6

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
894e522
Add running examples section
Ajay-singh1 Jul 21, 2026
f32c62c
Add examples to CI workflow
Ajay-singh1 Jul 22, 2026
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
6 changes: 4 additions & 2 deletions .github/workflows/check.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,8 +50,10 @@ jobs:
with:
toolchain: nightly
components: cargo,clippy,rustfmt
- name: Run default Rust crate
run: # cargo run --all-features --bin-name TODO
- name: Run example binaries
run: |
cargo run --all-features --bin multiple-args
cargo run --all-features --bin multiple-mixed-args

clippy-rust:
name: 4. Clippy lints on Rust crates
Expand Down
4 changes: 2 additions & 2 deletions Cargo.lock
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

14 changes: 14 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,3 +13,17 @@ cd overloading-macros
rustup override set nightly
cargo build
```

## Running Examples

Run individual example binaries with:

```sh
cargo run --bin <filename>
```

For example:

```sh
cargo run --bin multiple-args

@teor2345 teor2345 Jul 21, 2026

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please add all the examples to CI as well, so that we check the examples actually run:

overloading-macros/.github/workflows/check.yml

Line 54 in e5ab308

run: # cargo run --all-features --bin-name TODO

It is ok to just add a list of names for now, I don't think there's any easy way to get a list of binaries in a crate.

```