Readme files for complex packages
For packages that have many different elements (e.g., vr.teachr.measurements), I feel that it may be best to have one Readme at the top level that contains an overview for the whole package along with subsections for each of the various elements, in the interests of readability/accessibility. However, others have suggested that it is better for each element to have its own encapsulated Readme.
Relatedly, including images in Readme files seems to be challenging--including images in the Readme directory may result in deletion by subsequent merges.
A possible solution to both issues may be:
- create a separate images directory for all packages that need images in their Readme
- use hyperlinks to the Readme of each separate element