diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 858e42296..d8765cac8 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -5,7 +5,7 @@ on: paths: - docs/** branches: - - main + - master jobs: deploy: diff --git a/README.md b/README.md index 0d4b29971..4f11ce1ac 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,9 @@ 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. + +You can get more configure information from [Dioxus CLI Document](https://dioxuslabs.com/cli/configure.html). \ No newline at end of file diff --git a/src/builder.rs b/src/builder.rs index 5d192dfc0..2caa20b90 100644 --- a/src/builder.rs +++ b/src/builder.rs @@ -8,7 +8,7 @@ use cargo_metadata::{diagnostic::Diagnostic, Message}; use indicatif::{ProgressBar, ProgressStyle}; use serde::Serialize; use std::{ - fs::{copy, create_dir_all, remove_dir_all, File}, + fs::{copy, create_dir_all, File}, io::Read, panic, path::PathBuf, @@ -241,7 +241,7 @@ pub fn build(config: &CrateConfig, quiet: bool) -> Result { }) } -pub fn build_desktop(config: &CrateConfig, is_serve: bool) -> Result<()> { +pub fn build_desktop(config: &CrateConfig, _is_serve: bool) -> Result<()> { log::info!("🚅 Running build [Desktop] command..."); let ignore_files = build_assets(config)?;