Skip to content

Updated README with cargo generate instructions #35

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Updated README with cargo generate instructions #35

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,22 @@ for the user interface. It demonstrates the integration between the `.slint` UI
Rust code, how to react to callbacks, get and set properties, and use basic widgets.

## Usage
1. Install [Rust](https://rust-lang.org/learn/get-started/) and [Cargo Generate](https://github.com/cargo-generate/cargo-generate)
2. Use this template using `cargo generate`
```
cargo generate --name my-project --git https://github.com/slint-ui/slint-rust-template
cd my-project
```
4. Build with `cargo`:
```
cargo build
```
5. Run the application binary:
```
cargo run
```

## Usage (manual)

1. Install Rust by following its [getting-started guide](https://www.rust-lang.org/learn/get-started).
Once this is done, you should have the `rustc` compiler and the `cargo` build system installed in your `PATH`.
Expand Down