The Common Project Template

A common project template to start of, batteries included.

How to use

1. Click the "Use this template" green button on the GitHub project page

2. Follow the instructions on the webpage to create a new project

3. Edit the real.README.md project README template, replace the following `placeholders to the appropriate content:

   • _project_name_
   • _project_summary_
   • _namespace_/_project_
   • _license_name_
   • _license_url_

   Also remove the unused To be addressed sections

4. Replace the Upstream-Name, Upstream-Contact, and Source field of the .reuse/dep5 REUSE DEP5 machine-readable copyright declaration document with appropriate content(project name, project's issue tracker's title and URL, and project's site URL)

5. Replace .markdownlint.yml with real.markdownlint.yml

6. Replace README.md(this document) with real.README.md

7. Commit all changes as a new revision(commit summary for reference: docs: Write project README prototype)

8. (If you've cloned the repository back to local) push local changes to the remote repository

Licensing

Unless otherwise noted, this product is licensed under 4.0 International version of the Creative Commons Attribution-ShareAlike license, or any of its recent versions you would prefer.

This work complies to the REUSE Specification, refer REUSE - Make licensing easy for everyone for info regarding the licensing of this product.