Skip to content

Commit 04db3bb

Browse files
committed
more typos, newline missing and update the README
... to better separate the different sections
1 parent 241d6e1 commit 04db3bb

2 files changed

Lines changed: 18 additions & 11 deletions

File tree

README.md

Lines changed: 17 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,25 @@
1-
# pybites_rust - Exercise downloader
1+
# pybites_rust
2+
3+
## Exercise downloader
24
Exercise downloader for https://rustplatform.com/
35

4-
## quickstart
6+
### Quickstart
57

68
- install the exercise downloader directly from GitHub, open a terminal and run:
79
```shell
810
cargo install --git https://github.com/markgreene74/pybites_rust.git
911
```
10-
- cd to the directory where you want to save the exercises
12+
- `cd` to the directory where you want to save the exercises
1113
- run the downloader
1214
```shell
1315
pybites-rust-download
1416
```
1517

16-
## compile it manually
18+
### Compile it manually
1719

18-
Maybe you want to have a look at the code, make some changes, try something new.
20+
Maybe you want to have a look at the code and make some changes.
1921

20-
- clone the repo and cd to the directory project
22+
- clone the repo and `cd` to the main directory of the project
2123
- compile the downloader
2224
```shell
2325
cd exercise_downloader && \
@@ -33,14 +35,19 @@ Maybe you want to have a look at the code, make some changes, try something new.
3335
```
3436
- the downloader will create `exercises` in the current directory
3537

36-
Alternatively, use the Makefile
38+
### Makefile
39+
40+
Alternatively, use the Makefile. Be aware that this will create `exercises` in the project main directory, where the `Makefile` is located.
41+
3742
```shell
3843
make download-exercises
3944
```
4045

41-
<details><summary>(Output example ...)</summary>
46+
### Examples
47+
48+
<details><summary>(Open to see some output examples ...)</summary>
4249

43-
Using `cargo` to install it from GitHub.
50+
Using `cargo` to install from GitHub.
4451

4552
```shell
4653
➜ cargo install --git https://github.com/markgreene74/pybites_rust.git
@@ -53,7 +60,7 @@ Using `cargo` to install it from GitHub.
5360
Compiling pybites-rust-download v0.1.2 (/my/home/.cargo/git/checkouts/pybites_rust-b497f94da89af8aa/d1afb2e/excercise_downloader)
5461
Finished `release` profile [optimized] target(s) in 15.61s
5562
Installing /my/home/.cargo/bin/pybites-rust-download
56-
Installed package `pybites-rust-download v0.1.0 (https://github.com/markgreene74/pybites_rust.git#d1afb2ec)` (executable `pybites-rust-download`) /15.8s
63+
Installed package `pybites-rust-download v0.1.2 (https://github.com/markgreene74/pybites_rust.git#d1afb2ec)` (executable `pybites-rust-download`) /15.8s
5764
5865
5966
```

exercise_downloader/Cargo.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,4 +9,4 @@ serde = { version = "1.0.225", features = ["derive"] }
99

1010
[[bin]]
1111
name = "pybites-rust-download"
12-
path = "src/main.rs"
12+
path = "src/main.rs"

0 commit comments

Comments
 (0)