Skip to content

Commit cea79e5

Browse files
authored
Update README.md
1 parent 46b75dc commit cea79e5

1 file changed

Lines changed: 23 additions & 9 deletions

File tree

‎README.md‎

Lines changed: 23 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,34 @@
11
# UNCHAIN-projects
22

3-
The project is in fact a simple markdown filesystem that is deployed as a static website using docusaurus.
3+
This builder's book for web3 developers is a simple markdown filesystem that is deployed as a static website using docusaurus. Generally, you do not need to install this project to use it, as it is already [publically accessible on the web](https://buidl.unchain.tech/).
4+
5+
However, as this book is open for anyone to edit and add new pages to, below are steps for anyone who wish to contribute.
46

57
## Local Development
68

9+
Fetch book source.
10+
```
11+
git clone https://github.com/unchain-tech/UNCHAIN-projects.git
12+
```
13+
Install dependencies. Since the project itself is mostly a collection of markdown file documentation, this is minimal and is mostly automated proofreading related stuff.
14+
```
15+
yarn install
16+
```
17+
18+
Set precommit hooks. Ensures that basic proofreading check runs before each commit.
19+
```
20+
npx simple-git-hooks
21+
```
22+
23+
Launch book locally. Most changes are reflected live without having to restart the server.
724
```
8-
$ yarn start
25+
yarn start
926
```
1027

11-
This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
28+
Generates static content into the `build` directory. This output can be served using any static contents hosting service.
29+
```
30+
$ yarn build
31+
```
1232

1333
### ✅ textlint について
1434

@@ -18,13 +38,7 @@ This command starts a local development server and opens up a browser window. Mo
1838
- see: https://github.com/prh/prh
1939
- textlint のルール定義: `.textlintrc`
2040

21-
## Build
22-
23-
```
24-
$ yarn build
25-
```
2641

27-
This command generates static content into the `build` directory and can be served using any static contents hosting service.
2842

2943
# Contributors
3044

0 commit comments

Comments
 (0)