Skip to content

Commit

Permalink
Update readme.md (#29)
Browse files Browse the repository at this point in the history
  • Loading branch information
yzhong52 authored Aug 27, 2024
1 parent 4868eb6 commit ee05858
Showing 1 changed file with 30 additions and 3 deletions.
33 changes: 30 additions & 3 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,9 @@

A command line tool for drawing tree structures with ascii characters.

- [Ascii Tree](#ascii-tree)
- [Installation](#installation)
- [Install Via Homebrew](#install-via-homebrew)
- [Install Via Cargo](#install-via-cargo)
- [Usage](#usage)
- [Input From File](#input-from-file)
- [Horizontal Tree](#horizontal-tree)
Expand All @@ -13,14 +15,39 @@ A command line tool for drawing tree structures with ascii characters.
- [Vertical Tree Multi Lines](#vertical-tree-multi-lines)
- [Development](#development)

## Usage
## Installation

### Install Via Homebrew

Install from crates.io <https://crates.io/crates/astree>:
Install homebrew https://brew.sh/:

```
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
```

Install astree:

```
brew tap ascii-draw/ascii-tree
brew install astree
```

### Install Via Cargo

Install cargo <https://doc.rust-lang.org/cargo/getting-started/installation.html>:

```
curl https://sh.rustup.rs -sSf | sh
```

Install astree from <https://crates.io/crates/astree>:

```
cargo install astree
```

## Usage

Check out the help message:

```
Expand Down

0 comments on commit ee05858

Please sign in to comment.