chore(readme): instructions for running examples
This commit is contained in:
parent
52bc409a1a
commit
7f3013e509
3 changed files with 27 additions and 1 deletions
|
|
@ -32,6 +32,8 @@ git reset --hard origin/master
|
||||||
git submodule update --init --recursive
|
git submodule update --init --recursive
|
||||||
```
|
```
|
||||||
|
|
||||||
|
The examples may then be run by their cargo project names, such as `just run cosmic-design-demo`.
|
||||||
|
|
||||||
To create a new COSMIC project, use `cargo new {{name_of_project}}` to create a new
|
To create a new COSMIC project, use `cargo new {{name_of_project}}` to create a new
|
||||||
project workspace, edit the `Cargo.toml` contained within, and add this to begin.
|
project workspace, edit the `Cargo.toml` contained within, and add this to begin.
|
||||||
|
|
||||||
|
|
|
||||||
24
examples/README.md
Normal file
24
examples/README.md
Normal file
|
|
@ -0,0 +1,24 @@
|
||||||
|
## `design-demo`
|
||||||
|
|
||||||
|
Showcase of all widgets and their styled variations for the purpose of demonstrating and
|
||||||
|
fine-tuning our design system.
|
||||||
|
|
||||||
|
```sh
|
||||||
|
just run cosmic-design demo
|
||||||
|
```
|
||||||
|
|
||||||
|
## `application`
|
||||||
|
|
||||||
|
Start here as a template for creating an application with libcosmic's application API.
|
||||||
|
|
||||||
|
```sh
|
||||||
|
just run cosmic-design demo
|
||||||
|
```
|
||||||
|
|
||||||
|
## `open-dialog`
|
||||||
|
|
||||||
|
Demonstrates how to create an open file dialog
|
||||||
|
|
||||||
|
```sh
|
||||||
|
just run open-dialog
|
||||||
|
```
|
||||||
|
|
@ -1,5 +1,5 @@
|
||||||
[package]
|
[package]
|
||||||
name = "open_dialog"
|
name = "open-dialog"
|
||||||
version = "0.1.0"
|
version = "0.1.0"
|
||||||
edition = "2021"
|
edition = "2021"
|
||||||
|
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue