Skip to content

Commit

Permalink
chore: document examples
Browse files Browse the repository at this point in the history
  • Loading branch information
MichaelMcDonnell authored Sep 19, 2024
1 parent 342ef6f commit 9a57e36
Showing 1 changed file with 73 additions and 0 deletions.
73 changes: 73 additions & 0 deletions examples/README.md
Original file line number Diff line number Diff line change
@@ -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.
Expand All @@ -8,10 +16,75 @@ 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

```sh
just run open-dialog
```

## `text-input`

Demonstrates how to use the text input widgets.

```sh
just run text-input
```

0 comments on commit 9a57e36

Please sign in to comment.