Skip to content

Commit 44d3911

Browse files
author
mokou
committed
feat: Rewrite default out text
This has been in place for a long time now, before we had an install script, so it ended up repeating a bunch of the same things that the install script does automatically. I rewrote it so that it gives more helpful information about how you're supposed to do Rustlings. Hopefully this will reduce the number of "I started Rustlings and it gave me an error" issues (no offense to anyone who opened one of those, it was pretty unclear that it _wasn't_ an error).
1 parent 28020d0 commit 44d3911

File tree

1 file changed

+21
-15
lines changed

1 file changed

+21
-15
lines changed

Diff for: default_out.txt

+21-15
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,25 @@
11
Thanks for installing Rustlings!
22

3-
Is this your first time?
3+
Is this your first time? Don't worry, Rustlings was made for beginners! We are
4+
going to teach you a lot of things about Rust, but before we can get
5+
started, here's a couple of notes about how Rustlings operates:
46

5-
Let's make sure you're up to speed:
6-
- You have Rust installed, preferably via `rustup`
7-
- You have `~/.cargo/bin` added to your PATH variable
8-
- You have cloned this repository (https://github.com/rust-lang/rustlings)
9-
- You have installed Rust language support for your editor
10-
- You have locally installed the `rustlings` command by running an
11-
installation script or manually executing:
7+
1. The central concept behind Rustlings is that you solve exercises. These
8+
exercises usually have some sort of syntax error in them, which will cause
9+
them to fail compliation or testing. Sometimes there's a logic error instead
10+
of a syntax error. No matter what error, it's your job to find it and fix it!
11+
You'll know when you fixed it because then, the exercise will compile and
12+
Rustlings will be able to move on to the next exercise.
13+
2. If you run Rustlings in watch mode (which we recommend), it'll automatically
14+
start with the first exercise. Don't get confused by an error message popping
15+
up as soon as you run Rustlings! This is part of the exercise that you're
16+
supposed to solve, so open the exercise file in an editor and start your
17+
detective work!
18+
3. If you're stuck on an exercise, there is a helpful hint you can view by typing
19+
'hint' (in watch mode), or running `rustlings hint myexercise`.
20+
4. If an exercise doesn't make sense to you, feel free to open an issue on GitHub!
21+
(https://github.com/rust-lang/rustlings/issues/new). We look at every issue,
22+
and sometimes, other learners do too so you can help each other out!
1223

13-
cargo install --force --path .
14-
15-
If you've done all of this (or even most of it), congrats! You're ready
16-
to start working with Rust.
17-
18-
To get started, run `rustlings watch` in order to get the first exercise.
19-
Make sure to have your editor open!
24+
Got all that? Great! To get started, run `rustlings watch` in order to get the first
25+
exercise. Make sure to have your editor open!

0 commit comments

Comments
 (0)