Skip to content

Commit 45d68d9

Browse files
committed
Auto merge of #232 - rust-lang:update-docs, r=fmoko
chore: Update docs for 2.0 Only merge this once we're ready to release 2.0.
2 parents bc32a63 + b4d41c1 commit 45d68d9

File tree

2 files changed

+11
-3
lines changed

2 files changed

+11
-3
lines changed

CONTRIBUTING.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,8 +35,11 @@ You want to make sure where in the file you add your exercise. If you're not sur
3535
```diff
3636
...
3737
+ [[exercises]]
38+
+ name = "yourTopicN"
3839
+ path = "exercises/yourTopic/yourTopicN.rs"
3940
+ mode = "compile"
41+
+ hint = """
42+
+ Some kind of useful hint for your exercise."""
4043
...
4144
```
4245

@@ -125,4 +128,4 @@ BREAKING CHANGE: This has to be done because lorem ipsum dolor
125128
Once you open a Pull Request, it may be reviewed or labeled (or both) until
126129
the maintainers accept your change. Then, [bors](https://github.com/bors) will
127130
run the test suite with your changes and if it's successful, automatically
128-
merge it in!
131+
merge it in!

README.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -80,10 +80,15 @@ This will do the same as watch, but it'll quit after running.
8080
In case you want to go by your own order, or want to only verify a single exercise, you can run:
8181

8282
```bash
83-
rustlings run exercises/path/to/exercise.rs
83+
rustlings run myExercise1
8484
```
8585

86-
In case you get stuck, there is usually a hint at the bottom of each exercise.
86+
In case you get stuck, you can run the following command to get a hint for your
87+
exercise:
88+
89+
``` bash
90+
rustlings hint myExercise1
91+
```
8792

8893
## Testing yourself
8994

0 commit comments

Comments
 (0)