Skip to content

Adding help output to README

Afonso Mukai requested to merge DM-1210_help_in_readme into master

Created by: rerpha

Description of work

There has been a few times where i can't get the filewriter to build and have tried to look in the README to find usage

Although this does add another step in maintenance, the only changes that affect CLI options are usually breaking, so should be documented in the README anyway.

Issue

Closes DM-1210

Acceptance Criteria

None

Unit Tests

None

Other

Updated Readme.

Code Review (To be filled in by the reviewer only)

  • Is the code of an acceptable quality?
  • Do the changes function as described and is it robust?

Nominate for Group Code Review (Anyone can nominate it)

Indicate if you think the code should be reviewed in a Thursday code review session.

  • Recommend for group code review

Also, nominate it on the code_review Slack channel (does someone want to automate this?).

Merge request reports