One paragraph of project description goes here.
Briefly address the 5 W's.
What is the project?
Who made it? Did you make it independently or with a team?
When did you make it? At what level of experience and proficiency were / are you?
Why did you make it? For fun? For an assignment? How does it relect you as a person?
Where did you make it? What school / class?
Note for school project: this may be the only thing someone visiting your page reads. Try to make a great impression. Make someone want to hire you. This section will also be useful to you in the future to remind you about the project.
Add an animated gif of your program running. You can use ShareX, GIPHY Capture or another tool. https://blog.github.com/2018-06-29-GIF-that-keeps-on-GIFing/
Note for school project: This is a great way for friends and family to easily see your project in action.
The markdown is 
For Python, use the output of your docstrings. For other languages, create a docs folder in your project. If using Java, generate JavaDoc in your IDE. If using C++, use Doxygen. Change repository settings (using Settings at top of page) to use GitHub Pages with your docs folder. Add a link to the javadoc/doxygen index.html file with this markdown: [Text to appear](URL)
The URL will be YourGitHubUserName.github.io/YourRepositoryName/foldername/filename
Do not include the docs folder name in your URL.
Sample: [JavaDoc](https://pv-cop.github.io/PV-README-TEMPLATE/javadoc/index.html)
JavaDoc
Such as a class diagram.
The markdown is 
For example, this image 9919.png is saved to the docs folder in my repository and the markdown is 
Instructions to get a copy of the project up and running on someone's local machine for development and testing purposes.
Note for real project: You want to be able to share your project and enable collaboration.
Note for school project: You want a potential client or hirer to be able to run your program.
- IDE used
- Other software used
- Resources used
Note for school project: Every section is an opportunity to make an impression. You could briefly add what you know about the IDE and describe your development skills.
This section is more important for real projects but is good to include in school projects.
One of the main purposes of GitHub and similar services is to provide a means for project collaboration.
Tell someone how they can contribute to this project.
- Your name
Public repositories on GitHub are often used to share open source software. For your repository to truly be open source, you'll need to license it so that others are free to use, change, and distribute the software. https://help.github.com/articles/licensing-a-repository/
You have the option to choose a license when you first create your repository.
If you need to create a license for an existing repository...
- Go to your repository.
- Click on "Create new file" Button.
- Type the file name as License.txt or License.md in the input box next to your repository name, a drop down button appears towards right side.
- Choose the type of license of your choice.
- Click "Commit new file" button at the bottom (Green button)
Credit https://stackoverflow.com/questions/31639059/how-to-add-license-to-an-existing-github-project
To choose a license, see https://choosealicense.com/
- Web sites utilized
- Classmates who helped
- Your professor or TA if they helped
Information about what has changed.
This section would not necessarily be in a real README.
It is a reference for you and a place to impress potential employers with your knowledge.
Identify what concepts you utilize so when you need to use them again you will know that you will find them here. Include a brief description of the concepts in your own words to help you prepare for related interview questions.