From 04d5c63f6bee3e1f5ae4d53cf141c757108dbfaf Mon Sep 17 00:00:00 2001
From: Matthew Carbone <x94carbone@gmail.com>
Date: Sat, 1 Jul 2023 12:24:42 -0400
Subject: [PATCH] Add additional development instruction

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

diff --git a/README.md b/README.md
index fe07a655..284cf8e6 100644
--- a/README.md
+++ b/README.md
@@ -57,8 +57,28 @@ To install Lightshow, simply use `pip`
 pip install lightshow
 ```
 
+Make sure you've set your Pymatgen legacy API key as well!
+
+```bash
+export PMG_API_KEY="your_legacy_materials_project_key"
+```
+
+(or preferably, add `PMG_API_KEY` to your bash profile).
+
 More details can be found at our [documentation](https://ai-multimodal.github.io/Lightshow/installation.html).
 
+## Development installation
+
+For developers: after cloning Lightshow locally, install `pre-commit` via
+
+```bash
+pip install pre-commit
+pre-commit
+pre-commit install
+```
+
+and check that the tests (below) work correctly.
+
 ## Running tests
 
 For developers: tests can be run via `pytest`. After cloning, simply use
@@ -67,6 +87,12 @@ For developers: tests can be run via `pytest`. After cloning, simply use
 pytest lightshow/_tests
 ```
 
+or with coverage
+
+```bash
+pytest -v --cov --cov-report xml lightshow/_tests
+```
+
 
 # Contributing