Skip to content

Commit

Permalink
Add readme instructions for linting
Browse files Browse the repository at this point in the history
  • Loading branch information
bpurinton committed Feb 6, 2025
1 parent fe28366 commit 4a74ee9
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -206,9 +206,12 @@ $ git clone [email protected]:uw-cryo/asp_plot.git
$ cd asp_plot
$ conda env create -f environment.yml
$ conda activate asp_plot
$ pre-commit install
$ pip install -e .
```

**Please don't miss the `pre-commit install` step**, which does the linting prior to any commits using the `.pre-commit-config.yaml` file that is included in the repo.

If you want to rebuild the package, for instance while testing changes to the CLI tool, then uninstall and reinstall via:

```
Expand Down

0 comments on commit 4a74ee9

Please sign in to comment.