From 8deac65f99b266782a4ac7e38c28c05bd2e2ede9 Mon Sep 17 00:00:00 2001 From: Andrew White Date: Fri, 6 Oct 2023 14:44:17 -0700 Subject: [PATCH] Added more details to README --- README.md | 23 ++++++++++++++++++++++- 1 file changed, 22 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 4ca9f33..4750c64 100644 --- 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 -``` \ No newline at end of file +pre-commit run --all-files +``` + +After that, it will run automatically \ No newline at end of file