Added more details to README

whitead · Oct 6, 2023 · 8deac65 · 8deac65
1 parent 10632a3
commit 8deac65
Showing 1 changed file with 22 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -1,9 +1,30 @@
 # SanClone
 
+
+## Installation
+
+```sh
+pip install -e .
+```
+
+## Testing
+
+```sh
+pip install -r dev-requirements.txt
+pytest
+```
+
 ## Developing
 
+To contribute, make sure to run the pre-commit hooks before committing.
+
+
+### First time setup
 ```sh
 # install pre-commit
 pip install -r dev-requirements.txt
 pre-commit install
-```
+pre-commit run --all-files
+```
+
+After that, it will run automatically