From b2ac3c1124a870bf1801bb975e71a795d361bfc8 Mon Sep 17 00:00:00 2001 From: saki-osive Date: Sun, 17 Jan 2021 21:30:02 +0530 Subject: [PATCH 1/2] Refactored build steps for better readability --- .gitignore | 1 + README.md | 19 ++++++++++++++++--- 2 files changed, 17 insertions(+), 3 deletions(-) diff --git a/.gitignore b/.gitignore index 6bb908208..562480eb9 100644 --- a/.gitignore +++ b/.gitignore @@ -1,2 +1,3 @@ book stable-check/ +.idea \ No newline at end of file diff --git a/README.md b/README.md index 23d24218c..45adfa4ed 100644 --- a/README.md +++ b/README.md @@ -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 From 632cdd448e8b594f4cf8fc52fb0535e60d5e7d7d Mon Sep 17 00:00:00 2001 From: saki-osive Date: Sun, 17 Jan 2021 23:05:07 +0530 Subject: [PATCH 2/2] Added .idea in exclude section --- .gitignore | 1 - 1 file changed, 1 deletion(-) diff --git a/.gitignore b/.gitignore index 562480eb9..6bb908208 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,2 @@ book stable-check/ -.idea \ No newline at end of file