Update README.md

nwlandry · Dec 4, 2023 · 678d8cf · 678d8cf
1 parent 0849306
commit 678d8cf
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -1 +1,7 @@
 # modeling-and-inferring-higher-order-contagion-spread
+
+Some things:
+
+* To run the unit tests, you need to pip install the package locally. Navigate to the local folder on your computer and run "pip install -e ."
+* To run the unit tests, run "pytest" in the command line.
+* The package is referenced as `lcs` (Learning complex structure) when accessing the functionality.