The markdown files can be checked using markdownlint. Once the linter is installed one can run it locally from the root of this repository using
mdl .
It will automatically read the markdownlint configuration of this repository. The linter is configured in the files .mdl.rb
and .mdlrc
. The majority of the configuration is done in .mdl.rb
.
In several parts of the material, we use content from
Irving, Hertweck, Johnston, Ostblom, Wickham, and Wilson: Research Software Engineering with Python, 2021,
a book, which we also recommend to recap Git/Bash/Python basics.
This work is licensed under a Creative Commons Attribution 4.0 International License.