Skip to content

Commit b2ac3c1

Browse files
committed
Refactored build steps for better readability
1 parent fb1ce8a commit b2ac3c1

File tree

2 files changed

+17
-3
lines changed

2 files changed

+17
-3
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,3 @@
11
book
22
stable-check/
3+
.idea

README.md

Lines changed: 16 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,15 +14,28 @@ what we have for now.
1414

1515
## Build steps
1616

17-
First, go to the repository folder and test the code snippets to catch
18-
compilation errors:
17+
To build the project, follow the steps given below :
18+
19+
Clone the project by downloading the ZIP from the [GitHub page](https://github.com/rust-lang/reference) or
20+
run the following command:
21+
22+
```
23+
git clone https://github.com/rust-lang/reference
24+
```
25+
26+
Change the directory to the downloaded repository:
1927

2028
```sh
2129
cd reference
30+
```
31+
Run the following command to test the code snippets to catch compilation errors:
32+
33+
```shell
2234
mdbook test
2335
```
2436

25-
And then generate the book:
37+
38+
To generate a local instance of the book, run:
2639

2740
```sh
2841
mdbook build

0 commit comments

Comments
 (0)