aboutsummaryrefslogtreecommitdiff
path: root/proverb/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'proverb/README.md')
-rw-r--r--proverb/README.md97
1 files changed, 97 insertions, 0 deletions
diff --git a/proverb/README.md b/proverb/README.md
new file mode 100644
index 0000000..b9efe0b
--- /dev/null
+++ b/proverb/README.md
@@ -0,0 +1,97 @@
1# Proverb
2
3For want of a horseshoe nail, a kingdom was lost, or so the saying goes.
4
5Given a list of inputs, generate the relevant proverb. For example, given the list `["nail", "shoe", "horse", "rider", "message", "battle", "kingdom"]`, you will output the full text of this proverbial rhyme:
6
7```text
8For want of a nail the shoe was lost.
9For want of a shoe the horse was lost.
10For want of a horse the rider was lost.
11For want of a rider the message was lost.
12For want of a message the battle was lost.
13For want of a battle the kingdom was lost.
14And all for the want of a nail.
15```
16
17Note that the list of inputs may vary; your solution should be able to handle lists of arbitrary length and content. No line of the output text should be a static, unchanging string; all should vary according to the input given.
18
19## Rust Installation
20
21Refer to the [exercism help page][help-page] for Rust installation and learning
22resources.
23
24## Writing the Code
25
26Execute the tests with:
27
28```bash
29$ cargo test
30```
31
32All but the first test have been ignored. After you get the first test to
33pass, open the tests source file which is located in the `tests` directory
34and remove the `#[ignore]` flag from the next test and get the tests to pass
35again. Each separate test is a function with `#[test]` flag above it.
36Continue, until you pass every test.
37
38If you wish to run all ignored tests without editing the tests source file, use:
39
40```bash
41$ cargo test -- --ignored
42```
43
44To run a specific test, for example `some_test`, you can use:
45
46```bash
47$ cargo test some_test
48```
49
50If the specific test is ignored use:
51
52```bash
53$ cargo test some_test -- --ignored
54```
55
56To learn more about Rust tests refer to the [online test documentation][rust-tests]
57
58Make sure to read the [Modules][modules] chapter if you
59haven't already, it will help you with organizing your files.
60
61## Further improvements
62
63After 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.
64
65To format your solution, inside the solution directory use
66
67```bash
68cargo fmt
69```
70
71To see, if your solution contains some common ineffective use cases, inside the solution directory use
72
73```bash
74cargo clippy --all-targets
75```
76
77## Submitting the solution
78
79Generally 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.
80
81## Feedback, Issues, Pull Requests
82
83The [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!
84
85If you want to know more about Exercism, take a look at the [contribution guide](https://github.com/exercism/docs/blob/master/contributing-to-language-tracks/README.md).
86
87[help-page]: https://exercism.io/tracks/rust/learning
88[modules]: https://doc.rust-lang.org/book/ch07-02-defining-modules-to-control-scope-and-privacy.html
89[cargo]: https://doc.rust-lang.org/book/ch14-00-more-about-cargo.html
90[rust-tests]: https://doc.rust-lang.org/book/ch11-02-running-tests.html
91
92## Source
93
94Wikipedia [http://en.wikipedia.org/wiki/For_Want_of_a_Nail](http://en.wikipedia.org/wiki/For_Want_of_a_Nail)
95
96## Submitting Incomplete Solutions
97It's possible to submit an incomplete solution so you can see how others have completed the exercise.