From 948864d51c748cbcb91e4555fefb1f75f005c474 Mon Sep 17 00:00:00 2001 From: Mike Date: Sun, 10 Nov 2019 01:36:48 -0500 Subject: [PATCH] Added Doxygen, and sem-ver --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 16d092b..d94b92e 100644 --- a/README.md +++ b/README.md @@ -12,10 +12,12 @@ 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. ## Configuration All configuration is done in config.py. The only currently required configuration is to set book_path to the location of your books.