Skip to content

REAMDE.rst could need some love #12

@sbuerk

Description

@sbuerk

A README.md, REAMDE.rst or similar is the first
place contributors would look into for some kind of
intstruction on how to contribute workflow is is or
how to execute the several tools.

For that, maybe we should donate some love to the
README.rst for:

  • explain what this package is for/what it does
  • explain shortly prefered contribution steps
  • explain Build/Scripts/runTests.sh for CI and local usage
  • add build badge(s) from the job executions

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions