mirror of
https://github.com/m1ngsama/documents.git
synced 2025-12-24 10:51:23 +00:00
update readme
This commit is contained in:
parent
57edc2dfb5
commit
a5362228f3
1 changed files with 33 additions and 1 deletions
34
README.md
34
README.md
|
|
@ -1,3 +1,35 @@
|
||||||
# documents
|
# documents
|
||||||
|
|
||||||
协会文档
|
Documents for nbtca.
|
||||||
|
|
||||||
|
## How to use
|
||||||
|
|
||||||
|
### Install dependencies
|
||||||
|
|
||||||
|
1. Install Node.js
|
||||||
|
2. Install pnpm
|
||||||
|
```bash
|
||||||
|
npm install -g pnpm
|
||||||
|
```
|
||||||
|
3. Install dependencies
|
||||||
|
```bash
|
||||||
|
pnpm install
|
||||||
|
```
|
||||||
|
|
||||||
|
### Start development server
|
||||||
|
|
||||||
|
```bash
|
||||||
|
pnpm docs:dev
|
||||||
|
```
|
||||||
|
|
||||||
|
### Build for production
|
||||||
|
|
||||||
|
```bash
|
||||||
|
pnpm docs:build
|
||||||
|
```
|
||||||
|
|
||||||
|
### Lint code
|
||||||
|
|
||||||
|
```bash
|
||||||
|
pnpm lint
|
||||||
|
```
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue