FAIRmat-NFDI / nomad-distro-template

An example repository for creating a nomad distribution with custom plugins.
Apache License 2.0
7 stars 2 forks source link

Improving README.md #20

Closed lauri-codes closed 1 month ago

lauri-codes commented 3 months ago

Here are a few suggestions:

  1. The README.md itself has very little instructions before you have created a new repo. Instead of having two readme files (README.md and template_README.md), could we have a single readme? This way this repository would have all of the required steps already visible and would also be directly forkable (in this case the user will need to do modifications manually, as actions are by default disabled on forks). At the top of the README.md we would still explain how to create your own copy by using this as a template.

  2. The template_README.md has some issues:

    • Add correct indentation to code blocks within bullet points (three spaces before the code block)
    • Remove the note of needing to modify nomad.yaml for adding plugins. This is not necessary with the new plugin system.