Skip to content

Commit

Permalink
Clarify setup instructions in README
Browse files Browse the repository at this point in the history
  • Loading branch information
humphd committed Oct 15, 2023
1 parent bf68f43 commit 1bcc9c2
Showing 1 changed file with 8 additions and 2 deletions.
10 changes: 8 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,10 +18,16 @@ The easiest way to use it is with the [pixi](https://prefix.dev/docs/pixi/overvi

### Installation Steps

1. Clone this repo using `git clone https://github.com/humphrem/action.git`. NOTE: the repo includes large `.onnx` model files, which will get downloaded if you have [`git-lfs`](https://git-lfs.com/) installed (otherwise we'll get them as part of the setup below).
1. Clone this repo using `git clone https://github.com/humphrem/action.git`
2. [Install pixi](https://prefix.dev/docs/pixi/overview#installation)
3. Start a terminal and navigate to the root of the Action project folder you just cloned, `cd action`
4. Enter the command `pixi run setup` to download, install, and setup everything you'll need
4. Enter the command `pixi run setup` to download the models (these are large, ~778M, and will take some time), install dependencies, and set up everything you'll need

```sh
git clone https://github.com/humphrem/action.git
cd action
pixi run setup
```

### Using the Pixi Shell Environment

Expand Down

0 comments on commit 1bcc9c2

Please sign in to comment.