Skip to content

Latest commit

 

History

History
50 lines (32 loc) · 2.74 KB

README.md

File metadata and controls

50 lines (32 loc) · 2.74 KB

Simulation Software Engineering Lecture Material

markdownlint PDFs CC BY 4.0

Material of the Simulation Software Engineering lecture. There are different ways how to get an overview:

Please note that we update the material over the course of each semester.

List of Chapters

  1. Version Control
  2. Virtualization and Containers
  3. Building and Packaging
  4. Documentation
  5. Testing and CI
  6. Miscellaneous

Linting

The markdown files can be checked using markdownlint. Once the linter is installed, 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.

Third-Party Content

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.

License

This work is licensed under a Creative Commons Attribution 4.0 International License.

CC BY 4.0