Skip to content

Commit f0df89f

Browse files
Merge pull request #63 from yassinebenaid/add-usage-docs
Create usage.md
2 parents d512b29 + ec86f20 commit f0df89f

File tree

2 files changed

+28
-0
lines changed

2 files changed

+28
-0
lines changed

docs/.vitepress/config.mts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@ export default defineConfig({
2222
{ text: "Quick Start", link: "/quick-start" },
2323
{ text: "Installation", link: "/installation" },
2424
{ text: "Supported Features", link: "/supported-features" },
25+
{ text: "Usage", link: "/usage" },
2526
],
2627
},
2728
],

docs/usage.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# Usage
2+
3+
_script.sh_:
4+
5+
```shell
6+
echo "Hello World"
7+
```
8+
9+
To build this script, simply run:
10+
11+
```shell
12+
13+
bunster build script.sh -o ./bin/my-program
14+
15+
```
16+
17+
This will create an executable program named `my-program` in the `./bin` directory.
18+
19+
Now you can run it
20+
21+
```shell
22+
23+
./bin/my-program
24+
25+
26+
# Output: Hello World
27+
```

0 commit comments

Comments
 (0)