Skip to content

Latest commit

 

History

History
16 lines (16 loc) · 871 Bytes

style_guide_readme.md

File metadata and controls

16 lines (16 loc) · 871 Bytes

Style Guide for Readme Files

[ Project Title]

Status

Overview

Provide a brief summary of the project.

Table of Contents

Conceptual Model [if applicable]

Provide a brief explanation of the various components of the project and project site (if applicable) and explain how they are related. Flow charts or diagrams may be helpful.

Related Resources [if applicable]

Provide a list of links and descriptions to other key resources associated with the project. If applicable, provide a link to the live project site.

Requirements

Provide the names of the hardware, software, libraries, tools, etc. that are necessary for running the project. If applicable, include links to relevant tutorials, version numbers, and descriptions.

Installation/Build notes [if applicable]

Examples [if applicable]

Credits

Release History