moabdali / megacheckers Goto Github PK

Use readme.md, a markdown document. They're super simple to make.

Also since your program has a GUI, it's important to include screenshots in your readme so that when someone comes to your repo, they immediately see your creation.

Here is some info on adding screenshots:

To add a screenshot to your readme that will show up on your GitHub's "homepage"

• Open an issue in your project
• Copy and paste an image or drag and drop an image file into the issue text area. There are also upload instructions in the issue.
• GitHub will create something that looks like this in your issue:

![SNAG-0767](https://user-images.githubusercontent.com/46163555/80380522-b2c09600-886d-11ea-92cc-e88e14e0917c.jpg)

• Copy this above line(s) of text that the Issue created for you
• Edit your readme.md file in your project
• Paste the line of text from the Issue in your readme.md
• The image will now be embedded in your readme and will show up when someone visits your GitHub page
• You'll look like a rock star!

No GUI is too small to show people. If you've taken the time to post it on GitHub, it's worthy of showing everyone. Trust me here... people LOVE seeing them. There are not many GUIs in the Python world and you are a part of the movement that's changing that!

I see you have no LICENSE file for this project. The default is copyright.

I would suggest releasing the code under the GPLv3 or AGPLv3 license so that others are encouraged to contribute changes back to your project.