Skip to content

Commit 85cb028

Browse files
markgreene74Giuseppe Cunsolo
authored andcommitted
update README to cover cargo install from GH
1 parent 1538af8 commit 85cb028

1 file changed

Lines changed: 46 additions & 16 deletions

File tree

README.md

Lines changed: 46 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,36 @@
1-
# pybites_rust
2-
My solutions for https://rustplatform.com/
1+
# pybites_rust - Exercise downloader
2+
Exercise downloader for https://rustplatform.com/
33

4-
## exercises
4+
## quickstart
55

6-
(placeholder)
6+
- install the `exercise_downloader` directly from GitHub, open a terminal and run:
7+
```shell
8+
cargo install --git https://github.com/markgreene74/pybites_rust.git
9+
```
10+
- cd to the directory where you want to save the exercises
11+
- run the downloader
12+
```shell
13+
exercises_downloader
14+
```
715

8-
## exercises_downloader
16+
## compile it manually
917

18+
Maybe you want to have a look at the code, make some changes, try something new.
19+
20+
- clone the repo and cd to the directory project
1021
- compile the downloader
11-
```shell
12-
cd exercises_downloader && \
13-
cargo build --release
14-
```
22+
```shell
23+
cd exercises_downloader && \
24+
cargo build --release
25+
```
1526
- cd back to the project main directory
16-
```shell
17-
cd ..
18-
```
27+
```shell
28+
cd ..
29+
```
1930
- run the downloader from the project main directory
20-
```shell
21-
./exercises_downloader/target/release/exercises_downloader
22-
```
31+
```shell
32+
./exercises_downloader/target/release/exercises_downloader
33+
```
2334
- the downloader will create `exercises` in the current directory
2435

2536
Alternatively, use the Makefile
@@ -29,8 +40,27 @@ make download-exercises
2940

3041
<details><summary>(Output example ...)</summary>
3142

43+
Using `cargo` to install it from GitHub.
44+
45+
```shell
46+
➜ cargo install --git https://github.com/markgreene74/pybites_rust.git
47+
Updating git repository `https://github.com/markgreene74/pybites_rust.git`
48+
Installing exercises_downloader v0.1.0 (https://github.com/markgreene74/pybites_rust.git#d1afb2ec)
49+
50+
(...)
51+
52+
53+
Compiling exercises_downloader v0.1.0 (/my/home/.cargo/git/checkouts/pybites_rust-b497f94da89af8aa/d1afb2e/exercises_downloader)
54+
Finished `release` profile [optimized] target(s) in 15.61s
55+
Installing /my/home/.cargo/bin/exercises_downloader
56+
Installed package `exercises_downloader v0.1.0 (https://github.com/markgreene74/pybites_rust.git#d1afb2ec)` (executable `exercises_downloader`) /15.8s
57+
58+
59+
```
60+
61+
Using `make` to compile and execute the exercise downloader.
62+
3263
```shell
33-
pybites_rust [ main][+]
3464
➜ make download-exercises
3565
make build-executable && \
3666
exercises_downloader/target/release/exercises_downloader && \

0 commit comments

Comments
 (0)