Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
pdmoerland opened this issue Jul 10, 2023 · 1 comment
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@pdmoerland
Copy link
Contributor

pdmoerland commented Jul 10, 2023

  • 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?
@pdmoerland pdmoerland added the documentation Improvements or additions to documentation label Jul 10, 2023
@pdmoerland pdmoerland changed the title Processing/0_SoftwareEnvironment/0_README.md Processing/0_SoftwareEnvironment/0_README.md and */0_README-ProjectSpecific.md Jul 11, 2023
@ahcvankampen
Copy link
Contributor

There are no longer ProjectSpecific and General files.

Compatibility of Markdown files with different editors remains an issue. Needs to be discussed. Switch to html?

The 0_SoftwareEnvironment subdirectory needs further thought.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants