Skip to content

Commit 9a57e36

Browse files
chore: document examples
1 parent 342ef6f commit 9a57e36

File tree

1 file changed

+73
-0
lines changed

1 file changed

+73
-0
lines changed

examples/README.md

Lines changed: 73 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,13 @@
11
# Examples
22

3+
## `applet`
4+
5+
Demonstrates how to create an applet.
6+
7+
```sh
8+
just run applet
9+
```
10+
311
## `application`
412

513
Start here as a template for creating an application with libcosmic's application API.
@@ -8,10 +16,75 @@ Start here as a template for creating an application with libcosmic's applicatio
816
just run application
917
```
1018

19+
## `calendar`
20+
21+
Demonstrates how to use the calendar widget.
22+
23+
```sh
24+
just run calendar
25+
```
26+
27+
## `config`
28+
29+
Demonstrates how to use the configuration system. There is no GUI in this
30+
example.
31+
32+
```sh
33+
just run config
34+
```
35+
36+
## `context-menu`
37+
38+
Demonstrates how to use the context menu widget.
39+
40+
```sh
41+
just run context-menu
42+
```
43+
44+
## `image-button`
45+
46+
Demonstrates how to use the image-button widget.
47+
48+
```sh
49+
just run image-button
50+
```
51+
52+
## `menu`
53+
54+
Demonstrates how use the menu widget.
55+
56+
```sh
57+
just run menu
58+
```
59+
60+
## `multi-window`
61+
62+
Demonstrates how to open multiple windows.
63+
64+
```sh
65+
just run multi-window
66+
```
67+
68+
## `nav-context`
69+
70+
Demonstrates how to use the navigation bar widget.
71+
72+
```sh
73+
just run nav-context
74+
```
75+
1176
## `open-dialog`
1277

1378
Demonstrates how to create an open file dialog
1479

1580
```sh
1681
just run open-dialog
1782
```
83+
84+
## `text-input`
85+
86+
Demonstrates how to use the text input widgets.
87+
88+
```sh
89+
just run text-input
90+
```

0 commit comments

Comments
 (0)