Mirrors/dioxus
2
0
Fork 0
mirror of https://github.com/DioxusLabs/dioxus synced 2024-11-24 05:03:06 +00:00
Code Issues Projects Releases Packages Wiki Activity

feat: commit code

Browse source
This commit is contained in:
YuKun Liu 2022-11-30 13:51:23 -08:00
parent c44777003b
commit c176c9f82f
1 changed files with 10 additions and 29 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

39
README.md
View file

@ -2,51 +2,28 @@
<h1>📦✨ Dioxus CLI </h1> <h1>📦✨ Dioxus CLI </h1>
<p><strong>Tooling to supercharge Dioxus projects</strong></p> <p><strong>Tooling to supercharge Dioxus projects</strong></p>
</div> </div>
**dioxus-cli** (inspired by wasm-pack and webpack) is a tool for getting Dioxus projects up and running. It handles all of the build, bundling, development and publishing to simplify web development.
`dioxus-cli` (inspired by wasm-pack and webpack) is a tool for getting Dioxus projects up and running. It handles all of the build, bundling, development and publishing to simplify web development.
# Installation ## Installation
## Stable ### Install stable version
``` ```
cargo install dioxus-cli cargo install dioxus-cli
``` ```
## Latest ### Install from git repository
``` ```
cargo install --git https://github.com/DioxusLabs/cli cargo install --git https://github.com/DioxusLabs/cli
``` ```
## Developing ### Install from local folder
``` ```
cargo install --path . --debug cargo install --path . --debug
``` ```
Now that `dioxus` is in the path, use `dioxus --help` to see the help information.
```
dioxus 0.1.2
Build, Bundle & Ship Dioxus Apps
USAGE:
dioxus [FLAGS] <SUBCOMMAND>
FLAGS:
-h, --help Prints help information
-v Enable verbose logging
-V, --version Prints version information
SUBCOMMANDS:
build Build the Rust WASM app and all of its assets
clean Clean output artifacts
config Dioxus config file controls
create Init a new project for Dioxus
help Prints this message or the help of the given subcommand(s)
serve Build, watch & serve the Rust WASM app and all of its assets
translate Translate some source file into Dioxus code
```
## Get Started ## Get Started
Use `dioxus create project_name` to initialize a new Dioxus project. <br> Use `dioxus create project-name` to initialize a new Dioxus project. <br>
It will be cloned from the [dioxus-template](https://github.com/DioxusLabs/dioxus-template) repository. It will be cloned from the [dioxus-template](https://github.com/DioxusLabs/dioxus-template) repository.
@ -57,3 +34,7 @@ Alternatively, you can specify the template path:
``` ```
dioxus create hello --template gh:dioxuslabs/dioxus-template dioxus create hello --template gh:dioxuslabs/dioxus-template
``` ```
## Dioxus Config File
Dioxus CLI will use `Dioxus.toml` file to Identify some project info and switch some cli feature.