add directions

willow-ahrens · Jan 26, 2024 · d87f8b5 · d87f8b5
1 parent 75b0546
commit d87f8b5
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 1 deletion.
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -23,4 +23,4 @@ repos:
       args: ["--fix"]
       types_or: [ python, pyi, jupyter ]
     - id: ruff-format
-      types_or: [ python, pyi, jupyter ]
+      types_or: [ python, pyi, jupyter ]
diff --git a/README.md b/README.md
@@ -16,6 +16,19 @@ pip install finch
 
 Finch uses [poetry](https://python-poetry.org/) for packaging.
 
+To install for development, clone the repository and run:
+```bash
+poetry install --with test
+```
+to install the current project and dev dependencies.
+
+### Pre-commit hooks
+
+To add pre-commit hooks, run:
+```bash
+poetry run pre-commit install
+```
+
 ### Testing
 
 Finch uses [pytest](https://docs.pytest.org/en/latest/) for testing. To run the