Move book dev instructions out of top-level readme
This commit is contained in:
28
README.md
28
README.md
@ -61,34 +61,6 @@ $ git clone https://github.com/solana-labs/solana.git
|
|||||||
$ cd solana
|
$ cd solana
|
||||||
```
|
```
|
||||||
|
|
||||||
Building the Solana book
|
|
||||||
---
|
|
||||||
|
|
||||||
Install mdbook:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
cargo install mdbook
|
|
||||||
```
|
|
||||||
|
|
||||||
Run any Rust tests in the markdown:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
make -C book test
|
|
||||||
```
|
|
||||||
|
|
||||||
Render markdown as HTML:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
make -C book build
|
|
||||||
```
|
|
||||||
|
|
||||||
Render and view the book:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
make -C book open
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
Testing
|
Testing
|
||||||
---
|
---
|
||||||
|
|
||||||
|
26
book/README.md
Normal file
26
book/README.md
Normal file
@ -0,0 +1,26 @@
|
|||||||
|
Building the Solana book
|
||||||
|
---
|
||||||
|
|
||||||
|
Install mdbook:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
cargo install mdbook
|
||||||
|
```
|
||||||
|
|
||||||
|
Run any Rust tests in the markdown:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
make test
|
||||||
|
```
|
||||||
|
|
||||||
|
Render markdown as HTML:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
make build
|
||||||
|
```
|
||||||
|
|
||||||
|
Render and view the book:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
make open
|
||||||
|
```
|
Reference in New Issue
Block a user