th3r00t/pyShelf
1
0
Fork 0
mirror of https://github.com/th3r00t/pyShelf.git synced 2026-04-28 01:59:35 -04:00
Code Issues Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
th3r00t
2019-11-10 01:41:33 -05:00
committed by GitHub
parent afeee201b6
commit 640a5ff8de
1 changed files with 5 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
README.md
View File

@@ -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.