Exercism: Rust version of the 'Hello World' exercise.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

95 lines
3.3 KiB

3 years ago
  1. # Hello World
  2. The classical introductory exercise. Just say "Hello, World!".
  3. ["Hello, World!"](http://en.wikipedia.org/wiki/%22Hello,_world!%22_program) is
  4. the traditional first program for beginning programming in a new language
  5. or environment.
  6. The objectives are simple:
  7. - Write a function that returns the string "Hello, World!".
  8. - Run the test suite and make sure that it succeeds.
  9. - Submit your solution and check it at the website.
  10. If everything goes well, you will be ready to fetch your first real exercise.
  11. ## Rust Installation
  12. Refer to the [exercism help page][help-page] for Rust installation and learning
  13. resources.
  14. ## Writing the Code
  15. Execute the tests with:
  16. ```bash
  17. $ cargo test
  18. ```
  19. All but the first test have been ignored. After you get the first test to
  20. pass, open the tests source file which is located in the `tests` directory
  21. and remove the `#[ignore]` flag from the next test and get the tests to pass
  22. again. Each separate test is a function with `#[test]` flag above it.
  23. Continue, until you pass every test.
  24. If you wish to run all ignored tests without editing the tests source file, use:
  25. ```bash
  26. $ cargo test -- --ignored
  27. ```
  28. To run a specific test, for example `some_test`, you can use:
  29. ```bash
  30. $ cargo test some_test
  31. ```
  32. If the specific test is ignored use:
  33. ```bash
  34. $ cargo test some_test -- --ignored
  35. ```
  36. To learn more about Rust tests refer to the [online test documentation][rust-tests]
  37. Make sure to read the [Modules][modules] chapter if you
  38. haven't already, it will help you with organizing your files.
  39. ## Further improvements
  40. After you have solved the exercise, please consider using the additional utilities, described in the [installation guide](https://exercism.io/tracks/rust/installation), to further refine your final solution.
  41. To format your solution, inside the solution directory use
  42. ```bash
  43. cargo fmt
  44. ```
  45. To see, if your solution contains some common ineffective use cases, inside the solution directory use
  46. ```bash
  47. cargo clippy --all-targets
  48. ```
  49. ## Submitting the solution
  50. Generally you should submit all files in which you implemented your solution (`src/lib.rs` in most cases). If you are using any external crates, please consider submitting the `Cargo.toml` file. This will make the review process faster and clearer.
  51. ## Feedback, Issues, Pull Requests
  52. The [exercism/rust](https://github.com/exercism/rust) repository on GitHub is the home for all of the Rust exercises. If you have feedback about an exercise, or want to help implement new exercises, head over there and create an issue. Members of the rust track team are happy to help!
  53. If you want to know more about Exercism, take a look at the [contribution guide](https://github.com/exercism/docs/blob/main/contributing-to-language-tracks/README.md).
  54. [help-page]: https://exercism.io/tracks/rust/learning
  55. [modules]: https://doc.rust-lang.org/book/ch07-02-defining-modules-to-control-scope-and-privacy.html
  56. [cargo]: https://doc.rust-lang.org/book/ch14-00-more-about-cargo.html
  57. [rust-tests]: https://doc.rust-lang.org/book/ch11-02-running-tests.html
  58. ## Source
  59. This is an exercise to introduce users to using Exercism [http://en.wikipedia.org/wiki/%22Hello,_world!%22_program](http://en.wikipedia.org/wiki/%22Hello,_world!%22_program)
  60. ## Submitting Incomplete Solutions
  61. It's possible to submit an incomplete solution so you can see how others have completed the exercise.