From 640a5ff8de856637851b25b8120453b5b73cecb0 Mon Sep 17 00:00:00 2001 From: th3r00t Date: Sun, 10 Nov 2019 01:41:33 -0500 Subject: [PATCH] Update README.md --- README.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 9af86cc..951f42b 100644 --- a/README.md +++ b/README.md @@ -12,12 +12,16 @@ Thus I am creating pyShelf and I hope to be able to provide all the functionalit I am open to and hoping for community help in the design and execution of this program. ## Development -pyShelf uses ['sem-ver'](https://semver.org) + pyShelf uses [`pre-commit`](https://pre-commit.com/) to automate some tasks. Before developing, run `pre-commit install`. See the [documentation](https://pre-commit.com/) for more information. + pyShelf uses ['Doxygen'](https://http://www.doxygen.nl/) for source code documentation. Any changes to source should be documented and have run doxygen doxygen.conf prior to commiting. + +pyShelf follows ['sem-ver'](https://semver.org) standards. Before advancing version numbers be sure to set PROJECT_NUMBER in doxygen.conf accordingly. + ## Configuration All configuration is done in config.py. The only currently required configuration is to set book_path to the location of your books.