This template is intended for new projects to provide a structured README file.
// Code for existing users
if (code == undefined) {
alert('No code available yet!');
}
README template requires the following to run - assume zero prior knowledge when documenting:
- Markdown - a lightweight markup language
- another requirement
- ...
This README Template is easiest to use when copied to your projects main directory. Change its content with a text editor or with a special markdown editor.
code to install this project
Describe here how to add this to your project
code how to load or add this to your project
To contribute to this README template, fork the repository, make your changes and create a pull request.
If you're opening issues, please mention the version that the issue relates to.
README template is licensed under the ... license.
Copyright © 2018, Michael Meier
Use the following examples to extend your README with more information.
If your project does something already catered for by another project or is particularly complex, it’s useful to provide some justification.
A place for frequently asked questions, to reduce duplicate issues being opened.
Links out to example code or pointers on getting example applications running.
A section listing and thanking people who contributed to the project in a non-technical capacity.
Absolutely brilliant. Looks great! Thanks for putting this together!