Skip to content

Commit 3ff3366

Browse files
committed
Update README
1 parent 980f1e7 commit 3ff3366

1 file changed

Lines changed: 14 additions & 7 deletions

File tree

README.md

Lines changed: 14 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,32 @@
11
This project aims to generate html pages for *Pro Git* book from [*Book Source*](https://github.com/progit/progit) using node.js.
22

3-
The HTML pages can be host on the [GitHub](http://github.com) via gh-pages. You can find more info about gh-pages [here](http://pages.github.com/).
3+
The generated HTML pages can be hosted on the [GitHub](http://github.com) via [Github Pages](https://pages.github.com).
44

5-
You can visit [Here](http://iissnan.com/progit) to check out the demo.
5+
Checkout the [demo](http://iissnan.com/progit).
66

7-
## Build Procedure
7+
## How to build
88

9-
1. Download [Node.js](http://nodejs.org).
10-
2. Fork and clone this repository:
9+
1. Download and install [Node.js](http://nodejs.org).
10+
2. Get a copy of this project:
1111

1212
```
13-
git clone https://github.com/yourname/progit.git progit
13+
git clone https://github.com/iissnan/progit.git progit
1414
```
15-
3. Install Node Packages:
15+
16+
If you want to host this pages yourself, you need to fork this project to your account first.
17+
18+
19+
3. Install dependencies:
1620
1721
```
1822
npm install
1923
```
2024
2125
4. Get book source:
2226
27+
Book source is involved as a git submodule.
28+
Run the following command to init the submodule.
29+
2330
```
2431
git submodule init
2532
git submodule update

0 commit comments

Comments
 (0)