A simple README.md template

README-Template.md

Project Title

Simple overview of use/purpose.

Description

An in-depth paragraph about your project and overview of use.

Getting Started

Dependencies

• Describe any prerequisites, libraries, OS version, etc., needed before installing program.
• ex. Windows 10

Installing

• How/where to download your program
• Any modifications needed to be made to files/folders

Executing program

• How to run the program
• Step-by-step bullets

code blocks for commands

Help

Any advise for common problems or issues.

command to run if program contains helper info

Authors

Contributors names and contact info

ex. Dominique Pizzie
ex. @DomPizzie

Version History

• 0.2
  • Various bug fixes and optimizations
  • See commit change or See release history
• 0.1
  • Initial Release

License

This project is licensed under the [NAME HERE] License - see the LICENSE.md file for details

Acknowledgments

Inspiration, code snippets, etc.

• awesome-readme
• PurpleBooth
• dbader
• zenorocha
• fvcproductions

Cool!

Thank you

Thank you!

Thank you! =)

That's so helpful, thnx a lot!

Really nice, simple template! Thanks a lot!

TYSM

Thank you, simple and easy, exactly what I needed.

How can i add this code to a mod?

And where do i have to put this file and what file?

Thanks mate!

Thank you @DomPizzie. I was curious if such a standard existed and this is a great one! ;)

<3 thats a very fair point to start!

thanks a lot!

Template Looking Good

Thanks!

Thanks!

Thanks!

Thanks

Thanks.

thanks

Thanks

Absolute Chad. Thanks!

Thanks! Nice job

Thanks!

Great

This is a great sample for anyone who is just getting their feet wet with adding licenses.
Great sample. Thanks!

Thank you!

Thanks!

thanks

🙏. Simple, reasonably complete, enough but not too much.