Skip to content

Refactored build steps for better readability #936

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jan 27, 2021
Merged

Refactored build steps for better readability #936

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b2ac3c1
Refactored build steps for better readability
saki-osive Jan 17, 2021
632cdd4
Added .idea in exclude section
saki-osive Jan 17, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,2 +1,3 @@
book
stable-check/
.idea
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You can add this to ~/.config/git/ignore to apply it for your whole system or .git/info/exclude to apply it to this repo without having to commit it.

19 changes: 16 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,15 +14,28 @@ what we have for now.

## Build steps

First, go to the repository folder and test the code snippets to catch
compilation errors:
To build the project, follow the steps given below :

Clone the project by downloading the ZIP from the [GitHub page](https://github.com/rust-lang/reference) or
run the following command:

```
git clone https://github.com/rust-lang/reference
```

Change the directory to the downloaded repository:

```sh
cd reference
```
Run the following command to test the code snippets to catch compilation errors:

```shell
mdbook test
```

And then generate the book:

To generate a local instance of the book, run:

```sh
mdbook build
Expand Down