Skip to content

Commit d8854cc

Browse files
committed
Update README.md
1 parent 7284833 commit d8854cc

1 file changed

Lines changed: 65 additions & 2 deletions

File tree

README.md

Lines changed: 65 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,65 @@
1-
# ba-docs
2-
Installation, getting started & development docs
1+
# BerryAudio Documentation
2+
3+
Documentation for **BerryAudio**, built with VitePress.
4+
5+
## Installation
6+
7+
Install the dependencies:
8+
9+
```bash
10+
npm install
11+
```
12+
13+
## Bruno Collection
14+
15+
The Bruno API collection is located in:
16+
17+
```
18+
bruno/
19+
```
20+
21+
The collection is used to generate the API documentation.
22+
23+
## Development
24+
25+
Generate the API documentation:
26+
27+
```bash
28+
npm run docs:bruno
29+
```
30+
31+
Start the documentation site:
32+
33+
```bash
34+
npm run docs:dev
35+
```
36+
37+
The documentation will be available at:
38+
39+
```
40+
http://localhost:5173
41+
```
42+
43+
## Build
44+
45+
Build the documentation for production:
46+
47+
```bash
48+
npm run docs:build
49+
```
50+
51+
Preview the production build:
52+
53+
```bash
54+
npm run docs:preview
55+
```
56+
57+
## Commands
58+
59+
| Command | Description |
60+
| --- | --- |
61+
| `npm install` | Install dependencies |
62+
| `npm run docs:dev` | Start the documentation site |
63+
| `npm run docs:bruno` | Generate API documentation from `bruno/` |
64+
| `npm run docs:build` | Build the documentation |
65+
| `npm run docs:preview` | Preview the production build |

0 commit comments

Comments
 (0)