hello/README.md
| 1 | # hello |
| 2 | |
| 3 | Greets people from the command line. |
| 4 | |
| 5 | ## Usage |
| 6 | |
| 7 | | Argument | Description | |
| 8 | | -------- | ----------- | |
| 9 | | `NAME` | Optional. The name to greet. Only the first argument is read. Defaults to the `USER` environment variable, then to `world`. | |
| 10 | | `--shout` | Upper-cases the greeting. | |
| 11 | | `--version` | Prints the crate version and exits. | |
| 12 | | `--times N` | Prints the greeting `N` times. Defaults to 1. | |
| 13 | |
| 14 | ```sh |
| 15 | $ cargo run -- Ada |
| 16 | Hello, Ada! |
| 17 | ``` |
| 18 | |
| 19 | ```sh |
| 20 | $ cargo run -- --shout Ada |
| 21 | HELLO, ADA! |
| 22 | ``` |
| 23 | |
| 24 | ```sh |
| 25 | $ cargo run -- --times 2 Ada |
| 26 | Hello, Ada! |
| 27 | Hello, Ada! |
| 28 | ``` |
| 29 | |
| 30 | ```sh |
| 31 | $ cargo run -- --version |
| 32 | 0.1.0 |
| 33 | ``` |
| 34 | |
| 35 | With no name it greets whoever is signed in. |
| 36 | |
| 37 | ## Develop |
| 38 | |
| 39 | This project uses the Rust 2021 edition. |
| 40 | |
| 41 | ```sh |
| 42 | cargo test |
| 43 | ``` |
| 44 | |
| 45 | ## License |
| 46 | |
| 47 | This project is licensed under the MIT License. |
| 48 | The full license text is available at https://opensource.org/license/mit. |