From 4a74ee92ca5e114c7408f3e4031b270331d44d13 Mon Sep 17 00:00:00 2001
From: Ben Purinton <ben.purinton@gmail.com>
Date: Wed, 5 Feb 2025 17:18:16 -0800
Subject: [PATCH] Add readme instructions for linting

---
 README.md | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/README.md b/README.md
index ad69397..42f2ab6 100644
--- a/README.md
+++ b/README.md
@@ -206,9 +206,12 @@ $ git clone git@github.com: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:
 
 ```