|
1 | 1 | # Create your own programming language with Rust |
2 | 2 |
|
3 | 3 |  |
| 4 | + |
4 | 5 |
|
5 | | -This repository contains the codes and the contents for [createlang.rs](https://createlang.rs). |
| 6 | +This repository contains the codes and the contents for [createlang.rs](https://createlang.rs) |
6 | 7 |
|
7 | 8 | ## Why am I writing this book? |
8 | 9 |
|
9 | 10 | The book arises from my frustration of not finding modern, clear and concise teaching materials that are readily accessible to beginners like me who wants to learn a bit on how to create their own programming language. |
10 | 11 |
|
11 | 12 | The following are my guidelines |
12 | 13 |
|
13 | | -> "If you don't know how *compilers* work, then you don't know how computers work" <sup>[1]((http://steve-yegge.blogspot.com/2007/06/rich-programmer-food.html?))</sup> |
| 14 | +> "If you don't know how *compilers* work, then you don't know how computers work" <sup>[1](http://steve-yegge.blogspot.com/2007/06/rich-programmer-food.html?)</sup> |
14 | 15 | |
15 | 16 |
|
16 | 17 | > "If you can’t explain something in simple terms, you don’t understand it" <sup>[2](https://skeptics.stackexchange.com/questions/8742/did-einstein-say-if-you-cant-explain-it-simply-you-dont-understand-it-well-en)</sup> |
17 | 18 | |
18 | | -## Installation |
| 19 | +## Requirements |
19 | 20 |
|
20 | | -1. Install [Rustlang via rustup](https://www.rust-lang.org/tools/install) |
21 | | -2. Clone this repository and follow the instructions in each chapter |
22 | | -3. To build the book locally, navigate to the `book` repo and follow the instructions in [mdbook](https://github.com/rust-lang/mdBook) |
| 21 | +Make sure you have |
| 22 | + |
| 23 | +1. [Rust installed](https://www.rust-lang.org/tools/install) |
| 24 | +2. Cloned this repository (follow the instructions in each chapter) |
| 25 | +3. LLVM v10.0 installed ([Debina/Ubuntu](https://apt.llvm.org/) or [macOS](https://formulae.brew.sh/formula/llvm)) to run and test locally `cargo test --tests` |
| 26 | + |
| 27 | + |
| 28 | +To build the book locally, navigate to the `book` subdirectory and follow the instructions in [mdbook](https://github.com/rust-lang/mdBook). |
23 | 29 |
|
24 | 30 | ## Content outline |
25 | 31 |
|
|
0 commit comments