diff --git a/README.md b/README.md index 2e33aaf..a1fd385 100644 --- 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. \ No newline at end of file