From c176c9f82f98af87e9b72d77c2351e6c569b29fa Mon Sep 17 00:00:00 2001 From: YuKun Liu Date: Wed, 30 Nov 2022 13:51:23 -0800 Subject: [PATCH] feat: commit code --- README.md | 39 ++++++++++----------------------------- 1 file changed, 10 insertions(+), 29 deletions(-) diff --git a/README.md b/README.md index 0d4b29971..daaa8b7e9 100644 --- a/README.md +++ b/README.md @@ -2,51 +2,28 @@

📦✨ Dioxus CLI

Tooling to supercharge Dioxus projects

+**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 ``` -## Latest +### Install from git repository ``` cargo install --git https://github.com/DioxusLabs/cli ``` -## Developing +### Install from local folder ``` 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] - -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 -Use `dioxus create project_name` to initialize a new Dioxus project.
+Use `dioxus create project-name` to initialize a new Dioxus project.
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 Config File + +Dioxus CLI will use `Dioxus.toml` file to Identify some project info and switch some cli feature. \ No newline at end of file