Skip to content

Commit

Permalink
docs: update installation instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
SyedAhkam committed Oct 9, 2023
1 parent f41ffdf commit 1dd07ad
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 3 deletions.
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
15 changes: 12 additions & 3 deletions docs/src/get-started/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,20 +2,29 @@

## 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
```

## 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.

0 comments on commit 1dd07ad

Please sign in to comment.