add pre-commit and dev install instructions

SBU-BMI · Feb 21, 2024 · 16c7726 · 16c7726
1 parent 29b3c02
commit 16c7726
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -24,3 +24,19 @@ wsinfer-mil runlocal -m model.pt -c model.config.json \
 5. Save the results of the extracted features.
 
 This code includes caching, so feature extractors are not run more than they have to be.
+
+# Developers
+
+Clone and install `wsinfer-mil`:
+
+Clone the repository and make a virtual environment for it. Then install the dependencies, with `dev` extras.
+
+```
+pip install -e .[dev]
+```
+
+Configure `pre-commit` to run the formatter before commits happen.
+
+```
+pre-commit install
+```
diff --git a/pyproject.toml b/pyproject.toml
@@ -66,6 +66,7 @@ dev = [
     "geojson",
     "jsonschema",
     "mypy",
+    "pre-commit",
     "pytest",
     "ruff",
     "types-Pillow",