Readme.md Version# 2021.05.11 Review this site before modifing your Readme.md file:
https://medium.com/swlh/how-to-make-the-perfect-readme-md-on-github-92ed5771c061
Your Project Logo/Icon:
Very brief and to the point project description (one sentance preferred)
Clear semi-detailed professional description of your project. (about a paragraph or slightly more)
- Describe very briefly but clearly what the project does.
- State if it is out-of-the-box user-friendly, so it’s clear to the user.
- List its most useful/innovative/noteworthy features.
- State its goals/what problem(s) it solves.
- Note and briefly describe any key concepts (technical, philosophical, or both) important to the user’s understanding.
- Link to any supplementary blog posts or project main pages.
- Note its development status.
- If possible, include screenshots and demo videos.
| Type | Description |
|---|---|
| Language | C# |
| Development Environment | Visual Studio 2019 Community Edition |
| SQL Server Type | MS SQL or MySQL (whichever you used) |
| Target Environment | Windows 10 Desktop |
| Target Audience | Whatever your target audience is |
| Help System | Describe |
| Report Methods | HTML Reports |
- Why does this project exist?
- Frame your project for the potential user.
- Compare/contrast your project with other, similar projects so the user knows how it is different from those projects.
- Highlight the technical concepts that your project demonstrates or supports. Keep it very brief.
Include any essential instructions for:
- Getting your program
- Installing your program
- Configuring your program
- Running your program
- Versioning: Services, APIs, Systems
- Common Error Messages/related details
- Testing, validation, etc.
- URL for your Video Resume
- URL for your Product Overview Video
- URL for any other specific videos for this product
- Contributor Guidelines
- Code Requirements
- Format for commit messages
- Thank you (name contributors)
- Next steps
- Features planned
- Known bugs (shortlist)
| Contact | Information |
|---|---|
| Name | Your Name |
| Your Email Address | |
| Social Media Link | Your Social Media link(s) (if applicable) |
| Google Group/mailing list | Your mail distribution list (if applicable) |
Indicate your license/License model, etc.
(also, review the Instructions for adding a license file:
https://docs.github.com/en/github/building-a-strong-community/adding-a-license-to-a-repository)
[For the Final Project course, we will use the GNU General Public License v3.0] [When you add the License file, make sure you update the references within it to yours]
The three major licenses used are:
Apache License v2.0
GNU General Public License v3.0 [Use this one]
MIT License
Permissions of this strong copyleft license are conditioned on making available complete source code of licensed works and modifications, which include larger works using a licensed work, under the same license. Copyright and license notices must be preserved. Contributors provide an express grant of patent rights.