Mirrors/dioxus
2
0
Fork 0
mirror of https://github.com/DioxusLabs/dioxus synced 2024-09-19 22:01:54 +00:00
Code Issues Projects Releases Packages Wiki Activity

Finish the running examples section of the readme (#2889)

Browse source
This commit is contained in:
Evan Almloff 2024-08-29 01:52:53 +02:00 committed by GitHub
parent e5696cd72f
commit 0e937daaa1
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 19 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

20
README.md
View file

@ -221,7 +221,25 @@ Dioxus has grown from a side project to a small team of fulltime engineers. Than
## Running the examples
The examples in the top level of this repository can be run with `cargo run --example <example>`. However, we encourage you to download the dioxus-cli and run the examples with `dx serve` since many examples also support web. When running for web, you either need to modify the Cargo.toml to disable the default desktop feature, or use
> The examples in the main branch of this repository target the git version of dioxus and the CLI. If you are looking for examples that work with the latest stable release of dioxus, check out the [0.5 branch](https://github.com/DioxusLabs/dioxus/tree/v0.5/examples).
The examples in the top level of this repository can be run with:
```sh
cargo run --example <example>
```
However, we encourage you to download the dioxus-cli. If you are running the git version of dioxus, you can install the matching version of the CLI with:
```sh
cargo install --git https://github.com/DioxusLabs/dioxus dioxus-cli --locked
```
With the CLI, you can also run examples with the web platform. You just need to disable the default desktop feature and enable the web feature with this command:
```sh
dx serve --example <example> --platform web -- --no-default-features
```
## Dioxus vs other frameworks