forked from Code4HR/previous-landing
-
Notifications
You must be signed in to change notification settings - Fork 16
/
Copy pathReadMeTemplate
15 lines (8 loc) · 1.08 KB
/
ReadMeTemplate
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
What you see in <b>bold</b> is the title of the section that the Readme MUST have. Following the title of the section is a brief description of the what's required for that section. If you would like to add another section to your read me, you are welcome to, but it must have all these sections at a minimum.
<b>Name of Project</b>
<b>Description</b> - Minimum of 3 sentences long. Must mention what language the code is being written in (this does not count towards the 3 sentence minimum). Must be a non-technical worded description so even people who do not know the technical languages can understand what is being done.
<b>Current Features</b> - What the features are, and their descriptions, that the program currently has.
<b>Future Features</b> - What the currently hoped for future features, and their descriptions, of the program.
<b>Project Leader</b> - Name of leader and minimum one way to contact the leader.
<b>Contributors</b> - List of active contributors
<b>License</b> - Because this is a "Code for Miami" project, all projects MUST be open source. (www.choosealicense.com)