Skip to content

Commit

Permalink
readme: add crates.io install
Browse files Browse the repository at this point in the history
  • Loading branch information
marcelohdez committed Feb 19, 2024
1 parent de3f19b commit 350aaa5
Showing 1 changed file with 14 additions and 7 deletions.
21 changes: 14 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,20 +34,27 @@ environment variable will be run in the new directory.

## Installing

### Building Manually
**Ensure you have [Rust] installed.**

_Currently the only installation method_, ensure you have [Rust] installed.
You can install from `crates.io` using `cargo`:

After cloning this repo, `cd` into it and install by running:
```bash
cargo install atmpt
```

_Or_ you can build manually; After cloning this repo, `cd` into it and install by
running:

```bash
cargo install --path .
```

This should place `atmpt` in `$HOME/.cargo/bin`, but you will not have any
templates. You may either create them in the [data directory], or you could use
the default ones included in this repo _(example given for Unix-like systems
e.g. Linux or MacOS)_:
### Templates

Both of the methods above should place `atmpt` in `$HOME/.cargo/bin`, but you
will not have any templates. You may either create them in the [data directory],
or you could use the default ones included in this repo _(example given for
Unix-like systems e.g. Linux or MacOS)_:

```bash
mkdir -p $(atmpt -d)
Expand Down

0 comments on commit 350aaa5

Please sign in to comment.