Skip to content

Commit f2dd31b

Browse files
committed
Update README.md
1 parent f48e381 commit f2dd31b

File tree

1 file changed

+21
-4
lines changed

1 file changed

+21
-4
lines changed

README.md

+21-4
Original file line numberDiff line numberDiff line change
@@ -4,20 +4,37 @@
44

55
---
66

7-
## How to read this book?
7+
## 1. How to read this book?
88

99
This book is officially deployed at [https://hedgehog-book.github.io](https://hedgehog-book.github.io) with interactive examples.
1010

11-
## How to build this book locally?
11+
## 2. How to build this book locally?
1212

1313
1. Clone this repository to your local hard drive:
1414

1515
```
1616
git clone https://github.com/Hedgehog-Computing/docs.git
1717
```
1818

19-
2. Install next.js and its dependencies:
19+
2. Install next.js and its dependencies via `yarn install`:
2020

2121
```
22+
yarn install
23+
```
24+
25+
3. Serve a local next.js server:
26+
27+
```
28+
yarn next
29+
```
30+
31+
4. If you want to build the book as a static HTML website locally, run `yarn next build` and `yarn next export`:
32+
33+
```
34+
yarn next build
35+
yarn next export
36+
```
37+
38+
## 3. How to contribute to this book?
2239

23-
```
40+
s

0 commit comments

Comments
 (0)