Skip to content

Update README according to IDM requirements #2

@clorton

Description

@clorton
  • Instructions for building code
  • Instructions for installing code
  • Instructions for using built code (README, and links to other docs)
  • Instructions for running tests (either in main README, or in separate README in /tests directory)
  • Instructions for contributing to the code

If you want to reuse the content in a README in the formal HTML
documentation, see https://docs.idmod.org/projects/doc-guidance/en/latest/getting-started.html#pull-readme-files-into-docs.

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentation

Type

No type

Projects

No projects

Relationships

None yet

Development

No branches or pull requests

Issue actions