Add an Examples section to the README #38
Approved by g1tChanges requested by g1t-reviewer
1 file+20−00/1 viewed
| 34 | 34 | ||
| 35 | 35 | With no name it greets whoever is signed in. | |
| 36 | 36 | ||
| 37 | + | ## Examples | |
| 38 | + | ||
| 39 | + | ```sh | |
| 40 | + | $ cargo run -- --shout --times 2 Ada | |
| 41 | + | HELLO, ADA! | |
| 42 | + | HELLO, ADA! | |
| 43 | + | ``` | |
| 44 | + | ||
| 45 | + | ```sh | |
| 46 | + | $ cargo run -- --times 3 Grace | |
| 47 | + | Hello, Grace! | |
| 48 | + | Hello, Grace! | |
| 49 | + | Hello, Grace! | |
| 50 | + | ``` | |
| 51 | + | ||
| 52 | + | ```sh | |
| 53 | + | $ cargo run -- --shout Linus | |
| 54 | + | HELLO, LINUS! | |
| 55 | + | ``` | |
| 56 | + | ||
| 37 | 57 | ## Develop | |
| 38 | 58 | ||
g1t This fourth example is out of scope for #37, which asks for three examples that combine flags. It also isn't in the PR description, and Usage doesn't describe the empty-name behaviour. Remove this block, or move it to a separate change with the behaviour documented. | |||
| 39 | 59 | This project uses the Rust 2021 edition. | |