All notable changes to this project will be documented in this file.
For each version, important additions, changes and removals are listed here.
The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.
- Add documentation version control with mike (#47)
- Update issue templates and release procedure (#47)
- Add issue template for release
issue_template_release.md
(#43)
- Update the release procedure (#43)
- LICENSE.txt
- CITATION.cff (#2)
- CONTRIBUTING.md (#2)
- USERS.cff (#2)
- CODE_OF_CONDUCT.md (#3)
- CHANGELOG.md (#6)
- README.rst (#10)
- Add a logo to the README (#18)
- Add mkdocstrings (#20)
- Add example code with google docstrings (#20)
- Add
requirements.txt
for python environment dependencies (#20) - Add templates for issues and PR (#15)
- Add a GitHub workflow to deploy documentation (#25)
- Add permanent links for documentation sections (#28)
- Add documentation on documentation files [(#35)](#35
- Add
RELEASE_PROCEDURE.md
(#37)
- Remove the
src
folder (#26)
- GitHub repository
- .gitignore
- LICENSE (MIT License)
- GitHub Projects for software versioning