2
A simple README.md template
source link: https://gist.github.com/DomPizzie/7a5ff55ffa9081f2de27c315f5018afc
Go to the source link to view the article. You can view the picture content, updated content and better typesetting reading experience. If the link is broken, please click the button below to view the snapshot at that time.
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
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.
Recommend
About Joyk
Aggregate valuable and interesting links.
Joyk means Joy of geeK