Skip to content

Add README template and How-to doc#37

Open
aidanheerdegen wants to merge 1 commit into
mainfrom
add-readme-template
Open

Add README template and How-to doc#37
aidanheerdegen wants to merge 1 commit into
mainfrom
add-readme-template

Conversation

@aidanheerdegen
Copy link
Copy Markdown
Member

Add README_template.md and README How-to doc describing how to use it.

Closes #34

@aidanheerdegen
Copy link
Copy Markdown
Member Author

Note I have stripped down the template to only include the basic fields that need to be filled, and put all the descriptive text into a separate README.

It would be great to include one or more examples to help show what is required. Ideas/submissions would be welcome!

We could either include them in an examples subdir, or just link to examples in the repo (once they're there ... bit of a bootstrapping/ 🐔 and 🥚 problem.

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

Successfully merging this pull request may close these issues.

Template for README files for model configuration input files

1 participant