update readme

This commit is contained in:
Clas Wen 2025-04-03 19:54:01 +08:00
parent 57edc2dfb5
commit a5362228f3

View file

@ -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
```