doc/README is highly technical

Issue #298 closed
Robert Leach created an issue

USE CASE: WHAT DO YOU WANT TO DO?

Read the user manual

STEPS TO REPRODUCE AN ISSUE (OR TRIGGER A NEW FEATURE)

  1. Open doc/README

CURRENT BEHAVIOR

The user must execute command line commands (according to the document) to generate the user manual before they can read it.

EXPECTED BEHAVIOR

I expect the contents of the README to contain the user manual or that the manual is already generated and referred to in the README.

DEVELOPERS ONLY SECTION

SUGGESTED CHANGE (Pseudocode optional)

FILES AFFECTED (where the changes will be implemented) - developers only

LEVEL OF EFFORT - developers only

minor

COMMENTS

Is the user manual even relevant or is it left over from TV2?

Comments (3)

  1. Log in to comment