forked from udacity/git-styleguide
-
Notifications
You must be signed in to change notification settings - Fork 2
/
readme-styleguide.html
41 lines (39 loc) · 1.63 KB
/
readme-styleguide.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>NDITech Commit Style Guide</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="bower_components/normalize.css/normalize.css">
<link rel="stylesheet" href="//fonts.googleapis.com/css?family=Roboto:300|Roboto+Condensed:400,700|Inconsolata">
<link rel="stylesheet" href="css/style.css">
</head>
<body>
<nav>
<ul>
<li><a href="index.html">Commit Style Guide</a></li>
<li><a href="#">Code Versioning</a></li>
<li><a href="readme-styleguide.html" class="active">README Guide</a></li>
<li><a href="database-requisitions.html">Database Requisition SOP</a></li>
</ul>
</nav>
<h1 id="standardized-readme">Standardized README</h1>
<p>Standardized README.md files and documentation</p>
<h2 id="list-of-samples">List of samples</h2>
<ul>
<li><a href="./script.md">Standard Script Readme File</a></li>
</ul>
<h2 id="format">Format</h2>
<ul>
<li>NDI logo (looks nice)</li>
<li>Name of the Repo/Script/App</li>
<li>List of important stuff: license... (currently not using distributed continuous integration services like Travis or circleci)</li>
<li>List of Headings: makes it easier to navigate in long file.</li>
<li>Documentation: can include Testing.</li>
<li>Installation: guide so users can run the app.</li>
<li>Contributing: guide for other developers in the future.</li>
<li>License: best practice to include license, however this can be omitted.</li>
<li>Author(s)</li>
</ul>
</body>
</html>