Skip to content

Updated readme

Luc Everse requested to merge updated-readme into development

Description

Updates the readme with badges and instructions.

Changes

  • Removed everything

Additions

  • The name of the project is now the document's title
  • The logo is displayed on the right
  • Badges showing the build status and code coverage
  • Installation and usage instructions

Test and Review

To be filled in by the reviewers

  • All of the methods are commented to expectation

  • The methods are tested to satisfaction

  • There are no unnecessary files added to the PR

  • The continuous integration has no problems with the PR

  • The PR is filled in as requested e.g. labels added reviews requested

  • At least two members have reviewed this PR (4 in case of master branch)

Edited by Erik Oudsen

Merge request reports

Loading