Skip to content

Instantly share code, notes, and snippets.

@CodeMelted

CodeMelted/project-readme.md

Last active March 17, 2024 19:28
Show Gist options
  • Save CodeMelted/83e62ce113167422fa14784f0936283e to your computer and use it in GitHub Desktop.
Save CodeMelted/83e62ce113167422fa14784f0936283e to your computer and use it in GitHub Desktop.
Download ZIP
Hits all the important aspects of what one should document when starting a new GitHub project.
Raw
project-readme.md

PROJECT TITLE

[INTRODUCTION]

Table of Contents

FEATURES

[BREAKDOWN OF THE PROJECT. A SET OF USER STORIES OR USE CASES LINKED FROM HERE TO FURTHER BREAK DOWN THE PROJECT IF LARGE. ALSO A USE CASE MODEL IF NECESSARY. OR JUST INCLUDE ALL THE INFORMATION HERE IF NOT THAT MANY ITEMS]

GETTING STARTED

[HOW TO SETUP TO UTILIZE YOUR PROJECT]

USAGE

[HOW TO USE YOUR PROJECT IN THERE PROJECT]

LICENSE

[THE LICENSE FOR YOUR PROJECT]

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment