chore: document examples

This commit is contained in:
Michael Mc Donnell 2024-09-19 01:11:24 -10:00 committed by GitHub
parent 342ef6f1fa
commit 9a57e36d1c
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

View file

@ -1,5 +1,13 @@
# Examples
## `applet`
Demonstrates how to create an applet.
```sh
just run applet
```
## `application`
Start here as a template for creating an application with libcosmic's application API.
@ -8,6 +16,63 @@ Start here as a template for creating an application with libcosmic's applicatio
just run application
```
## `calendar`
Demonstrates how to use the calendar widget.
```sh
just run calendar
```
## `config`
Demonstrates how to use the configuration system. There is no GUI in this
example.
```sh
just run config
```
## `context-menu`
Demonstrates how to use the context menu widget.
```sh
just run context-menu
```
## `image-button`
Demonstrates how to use the image-button widget.
```sh
just run image-button
```
## `menu`
Demonstrates how use the menu widget.
```sh
just run menu
```
## `multi-window`
Demonstrates how to open multiple windows.
```sh
just run multi-window
```
## `nav-context`
Demonstrates how to use the navigation bar widget.
```sh
just run nav-context
```
## `open-dialog`
Demonstrates how to create an open file dialog
@ -15,3 +80,11 @@ Demonstrates how to create an open file dialog
```sh
just run open-dialog
```
## `text-input`
Demonstrates how to use the text input widgets.
```sh
just run text-input
```