Welcome to the documentation for logbookgenerator!¶
Generates a logbook. Designed for the University of Lincoln’s Scientific Computing module.
Features¶
☒ Installable via pip
☒ Command-line interface
☒ Interactive documentation
☐ Dynamically generate logbooks
Installation¶
To install logbookgenerator, simply run:
pip install logbookgenerator
Usage¶
After installation, you can use logbookgenerator by running:
$ python3 -m logbookgenerator
# or
$ logbookgenerator
Documentation¶
For more information, you can find the documentation within the docs directory or on the project’s [GitHub Pages](https://unkokaeru.github.io/logbookgenerator/).
Contributing¶
Contributions are welcome! Please refer to our CONTRIBUTING.md for more information.
License¶
This project is licensed under the MIT License - see the LICENSE file for details.