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

Added Doxygen, and sem-ver

Browse Source
This commit is contained in:
Mike
2019-11-10 01:36:48 -05:00
parent 88d2d26983
commit 948864d51c
1 changed files with 3 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
README.md
View File

@@ -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. I am open to and hoping for community help in the design and execution of this program.
## Development ## Development
pyShelf uses ['sem-ver'](https://semver.org)
pyShelf uses [`pre-commit`](https://pre-commit.com/) to automate some tasks. pyShelf uses [`pre-commit`](https://pre-commit.com/) to automate some tasks.
Before developing, run `pre-commit install`. Before developing, run `pre-commit install`.
See the [documentation](https://pre-commit.com/) for more information. 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 ## Configuration
All configuration is done in config.py. All configuration is done in config.py.
The only currently required configuration is to set book_path to the location of your books. The only currently required configuration is to set book_path to the location of your books.