From 1414ac3862d0ac309c48d4d0fe1d573fba52b072 Mon Sep 17 00:00:00 2001
From: levisweet <lsweet@vols.utk.edu>
Date: Wed, 31 Jan 2024 15:14:15 -0600
Subject: [PATCH] edit formatting, re-add developer setup

---
 README.md | 33 +++++++++++++++++++++++++++++----
 1 file changed, 29 insertions(+), 4 deletions(-)

diff --git a/README.md b/README.md
index ecf58f0ab0..89d959fd43 100755
--- a/README.md
+++ b/README.md
@@ -2,9 +2,9 @@
 [![codecov](https://codecov.io/gh/IMMM-SFA/naturf/graph/badge.svg?token=SoIfjdS6BL)](https://codecov.io/gh/IMMM-SFA/naturf)
 [![build](https://github.com/IMMM-SFA/naturf/actions/workflows/build.yml/badge.svg)](https://github.com/IMMM-SFA/naturf/actions/workflows/build.yml)
 
-## naturf
+# naturf
 
-#### `naturf` is an open-source geospatial Python package for calculating urban building parameters to be compiled and input to the Weather Research and Forecasting model (WRF).
+#### `naturf` (Neighborhood Adaptive Tissues for Urban Resilience Futures) is an open-source geospatial Python package for calculating urban building parameters to be compiled and input to the Weather Research and Forecasting model (WRF).
 
 ### Purpose
 `naturf` was created to:
@@ -38,9 +38,34 @@ Whether you find a typo in the documentation, find a bug, or want to develop fun
 
 The reference guide contains a detailed description of the `naturf` API. The reference describes how the methods work and which parameters can be used. It assumes that you have an understanding of the key concepts. See [API Reference](https://immm-sfa.github.io/naturf/modules.html)
 
-### Pre-commit
+### Developer Setup
 
-`naturf` uses `pre-commit`. Instructions for installation can be found [here](https://pre-commit.com/)
+To get started on development, install the pre-commit hooks to format code.
+
+For `homebrew`:
+
+```bash
+$ brew install pre-commit
+```
+
+For `pip`:
+
+```bash
+$ pip install pre-commit
+```
+
+For `conda`:
+
+```bash
+$ conda install -c conda-forge pre-commit
+```
+
+Then install the hooks within the repo:
+
+```bash
+$ cd /PATH/TO/NATURF
+$ pre-commit install
+```
 
 ### Code citation