As a user, it would be nice to have a README.txt file that is auto-generated from the metadata that has been provided.

[astrochun]

User story

As discussed in a number of meetings related to PDC, an ability to generate a README.txt based on a template and input metadata (e.g., authors, titles) to initiate the README would be a nice feature. This would mean that the metadata would need to be provided first. The benefit here is that we wouldn't be asking submitters to enter the information twice. More over, this would increase adoption of best practices. I think separate templates may be need as PPPL uses a version that differs from the one that PRDS distributes.

There are a number of templating tool available. I previously used jinja2 with Python:
https://palletsprojects.com/projects/jinja/

Acceptance criteria

• If this change touches any of the files referenced in .rubocop_todo.yml create a new ticket to address the rubocop todo.
• I can successfully use this feature with Voice Over in Safari.
• I have checked this feature using one of the following browser extensions and confirmed that it does not add any level A or level AA issues:
  • axe dev tools
  • Lighthouse
  • Wave
• ...

Concrete example

Implementation notes, if any