From 6ca0a0a4f95713cf8fd70322ca324c2e15072f6f Mon Sep 17 00:00:00 2001 From: YuKun Liu <41265098+mrxiaozhuox@users.noreply.github.com> Date: Sun, 20 Feb 2022 11:28:22 +0800 Subject: [PATCH] docs: add `installation` page --- docs/cli/src/SUMMARY.md | 1 + docs/cli/src/installation.md | 24 ++++++++++++++++++++++++ 2 files changed, 25 insertions(+) create mode 100644 docs/cli/src/installation.md diff --git a/docs/cli/src/SUMMARY.md b/docs/cli/src/SUMMARY.md index e0ff9f902..6d47af5eb 100644 --- a/docs/cli/src/SUMMARY.md +++ b/docs/cli/src/SUMMARY.md @@ -1,3 +1,4 @@ # Summary - [Introduction](./introduction.md) +- [Installation](./installation.md) \ No newline at end of file diff --git a/docs/cli/src/installation.md b/docs/cli/src/installation.md new file mode 100644 index 000000000..7151de1ff --- /dev/null +++ b/docs/cli/src/installation.md @@ -0,0 +1,24 @@ +# Installation + +There are multiple ways to install the Dioxus CLI tool. Choose any one of the methods below that best suit your needs. + +## Install from latest master version + +We suggest you use `github master` version to install it now. + +We have not yet released the latest version to `crates.io` + +``` +cargo install --git https://github.com/Dioxuslabs/cli +``` + +This will automatically download `Dioxus-CLI` source from github master branch, +and install it in Cargo's global binary directory (`~/.cargo/bin/` by default). + +## Install from `crates.io` version + +``` +cargo install dioxus-cli +``` + +Make sure to add the Cargo bin directory to your `PATH`. \ No newline at end of file