diff --git a/README.md b/README.md index 398bbdb..527d2c0 100644 --- a/README.md +++ b/README.md @@ -8,6 +8,10 @@ Create, build, and release Android apps faster without Android Studio. Android CLI is a powerful tool that simplifies and streamlines the Native Android development process. It provides a single interface for developers to create, build, and release Android applications without the need for cumbersome IDEs like Android Studio. +## Installation + +Refer to the [docs](https://android-cli.syed.world/get-started/installation.html). + ## Usage Android CLI offers a range of features and commands that can be executed from a single interface. Some of the key commands include: diff --git a/docs/src/get-started/installation.md b/docs/src/get-started/installation.md index 5530427..750be02 100644 --- a/docs/src/get-started/installation.md +++ b/docs/src/get-started/installation.md @@ -2,13 +2,13 @@ ## Using cargo -### From crates.io (no releases yet) +### From crates.io ```sh $ cargo install android-cli ``` -### From git directly +### From git directly (latest changes, may be unstable) ```sh $ cargo install --git https://github.com/SyedAhkam/android-cli.git @@ -16,6 +16,15 @@ $ cargo install --git https://github.com/SyedAhkam/android-cli.git ## Using github releases -No releases yet +Haven't set this up yet. Coming soon. + +## From source + +Ensure you have the latest stable version of Rust installed (with Cargo). Then, clone the repository and run the following command from the root of the repository: + +```sh +$ cargo install --path . +``` + > After installation, you should have access to the `android` binary from your choice of shell. \ No newline at end of file