From b4d41c1b7a90d5c8c2df4204dff52cba6297dba1 Mon Sep 17 00:00:00 2001 From: marisa Date: Mon, 11 Nov 2019 18:02:56 +0100 Subject: [PATCH] chore: Update docs for 2.0 --- CONTRIBUTING.md | 5 ++++- README.md | 9 +++++++-- 2 files changed, 11 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 98deb165..d566df08 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -35,8 +35,11 @@ You want to make sure where in the file you add your exercise. If you're not sur ```diff ... + [[exercises]] ++ name = "yourTopicN" + path = "exercises/yourTopic/yourTopicN.rs" + mode = "compile" ++ hint = """ ++ Some kind of useful hint for your exercise.""" ... ``` @@ -125,4 +128,4 @@ BREAKING CHANGE: This has to be done because lorem ipsum dolor Once you open a Pull Request, it may be reviewed or labeled (or both) until the maintainers accept your change. Then, [bors](https://github.com/bors) will run the test suite with your changes and if it's successful, automatically -merge it in! \ No newline at end of file +merge it in! diff --git a/README.md b/README.md index 405586f6..1b759b15 100644 --- a/README.md +++ b/README.md @@ -80,10 +80,15 @@ This will do the same as watch, but it'll quit after running. In case you want to go by your own order, or want to only verify a single exercise, you can run: ```bash -rustlings run exercises/path/to/exercise.rs +rustlings run myExercise1 ``` -In case you get stuck, there is usually a hint at the bottom of each exercise. +In case you get stuck, you can run the following command to get a hint for your +exercise: + +``` bash +rustlings hint myExercise1 +``` ## Testing yourself