Skip to content

Commit

Permalink
Update usage section of README
Browse files Browse the repository at this point in the history
  • Loading branch information
Jklein64 committed Jun 26, 2022
1 parent c4e2a34 commit cd557fa
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,9 @@ The name "QuILTER" is both a portmanteau of the project's subtitle and an allusi

# Usage

download cod
Until I feel like figuring out how to put this project on PyPI, you can either install the package through the `.tar.gz` file in this repository's Packages section, or clone the repo, create a [Conda](https://docs.conda.io/projects/conda/en/latest/user-guide/getting-started.html) environment using `conda env create -f environment.yml`, and build the project using `flit build`, which will create the same `.tar.gz` file in the `dist/` folder.

run
Once installed, access the CLI help with `quilter -h` or import the `feather_segments()` function from the `quilter` package.

# Examples

Expand Down

0 comments on commit cd557fa

Please sign in to comment.