Skip to content

Processing/0_SoftwareEnvironment/0_README.md and */0_README-ProjectSpecific.md #3

Description

@pdmoerland
  • Remove empty lines in the bullet list (otherwise Notepad++ gets confused)
  • Not clear why Export your environment(s) is mentioned several times:
    • In this file (0_README.md)
    • In the 0_README-ProjectSpecific.md files
  • All 0_README-ProjectSpecific.md files contain items for used hardware and operating system. In most cases this is probably shared in case multiple environments (for example Python and R) have been used. Then it makes more sense to include this information in 0_README.md. Should we allow for this?
  • Can't the last two items in the 0_README-ProjectSpecific.md files ('Did you add ....' and 'Export your environment') be combined?
  • What is meant by 'additional files' in the 0_README-ProjectSpecific.md files? Should the R session info, for example, be provided as a separate text file, which should then be mentoned in the corresponding 0_README-ProjectSpecific.md file? Or should this information be incuded in the 0_README-ProjectSpecific.md file itself?
  • Can the environments that are not used be removed? If so, at what stage of the project?

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentation

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions