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

Auto-generating README of modules #14

Open
Andros-Spica opened this issue Dec 2, 2022 · 0 comments
Open

Auto-generating README of modules #14

Andros-Spica opened this issue Dec 2, 2022 · 0 comments

Comments

@Andros-Spica
Copy link
Collaborator

Content in README.md is largely a duplicate print of contents already in NASSA.yml, except the "Further information" section. This involves an extra redundant task for authors, duplicated information in the module webpage, and could create inconsistencies due to copy-and-pasting text.

We could define an "information.md" also in the module's root, and then auto-generate the README.md file based on a general layout, the module NASSA.yml and then printing the content of "information.md".

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

No branches or pull requests

1 participant