-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathIntroduction.txt
69 lines (59 loc) · 52.2 KB
/
Introduction.txt
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
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
<!DOCTYPE html>
<!-- saved from url=(0028)https://www.makeareadme.com/ -->
<html lang="en"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><meta name="viewport" content="width=device-width, initial-scale=1"><title>Make a README</title><meta name="description" content="Learn how to make a great README for your programming project, and use the editable template to get started."><meta itemprop="name" content="Make a README"><meta itemprop="description" content="Learn how to make a great README for your programming project, and use the editable template to get started."><meta name="twitter:card" content="summary"><meta name="twitter:title" content="Make a README"><meta name="twitter:description" content="Learn how to make a great README for your programming project, and use the editable template to get started."><meta name="twitter:creator" content="@dannyguo"><meta property="og:title" content="Make a README"><meta property="og:description" content="Learn how to make a great README for your programming project, and use the editable template to get started."><meta property="og:url" content="https://www.makeareadme.com"><meta property="og:site_name" content="Make a README"><meta property="og:type" content="website"><meta property="og:image" content="https://www.makeareadme.com/images/open-graph-logo.png?v=20181203"><meta property="og:image:type" content="image/png"><meta property="og:image:width" content="1200"><meta property="og:image:height" content="630"><link rel="icon" type="image/x-icon" href="https://www.makeareadme.com/images/favicon.ico"><meta name="next-head-count" content="20"><link rel="preload" href="./Make a README_files/e122b20b95e84685.css" as="style" crossorigin=""><style class="anchorjs"></style><link rel="stylesheet" href="./Make a README_files/e122b20b95e84685.css" crossorigin="" data-n-g=""><noscript data-n-css=""></noscript><script defer="" crossorigin="" nomodule="" src="./Make a README_files/polyfills-c67a75d1b6f99dc8.js.download"></script><script src="./Make a README_files/anchor.min.js.download" defer="" data-nscript="beforeInteractive" crossorigin=""></script><script src="./Make a README_files/webpack-46e48e784029e2dc.js.download" defer="" crossorigin=""></script><script src="./Make a README_files/framework-6619afc465fdd2af.js.download" defer="" crossorigin=""></script><script src="./Make a README_files/main-f412f21ba3382130.js.download" defer="" crossorigin=""></script><script src="./Make a README_files/_app-3d93e17aed115caf.js.download" defer="" crossorigin=""></script><script src="./Make a README_files/c16184b3-95c95ad74623a29f.js.download" defer="" crossorigin=""></script><script src="./Make a README_files/5110-7905253f1f00f8f6.js.download" defer="" crossorigin=""></script><script src="./Make a README_files/index-ebb530207e9a6933.js.download" defer="" crossorigin=""></script><script src="./Make a README_files/_buildManifest.js.download" defer="" crossorigin=""></script><script src="./Make a README_files/_ssgManifest.js.download" defer="" crossorigin=""></script><style type="text/css" id="____GITHUB_CORNER_SUPER_SECRET___">
.github-corner:hover .octo-arm {
animation: octocat-wave 560ms ease-in-out;
}
@keyframes octocat-wave {
0%, 100% {
transform: rotate(0deg);
}
20%, 60% {
transform: rotate(-25deg);
}
40%, 80% {
transform: rotate(10deg);
}
}
@media (max-width: 500px) {
.github-corner:hover .octo-arm {
animation: none;
}
.github-corner .octo-arm {
animation: octocat-wave 560ms ease-in-out;
}
}
</style><style>[data-ea-publisher].loaded,[data-ea-type].loaded{font-size:14px;font-family:-apple-system,BlinkMacSystemFont,Segoe UI,Roboto,Helvetica Neue,Arial,Noto Sans,sans-serif,Apple Color Emoji,Segoe UI Emoji,Segoe UI Symbol,Noto Color Emoji;font-weight:normal;font-style:normal;leter-spacing:0px;vertical-align:baseline;line-height:1.3em}[data-ea-publisher].loaded a,[data-ea-type].loaded a{text-decoration:none}[data-ea-publisher].loaded .ea-pixel,[data-ea-type].loaded .ea-pixel{display:none}[data-ea-publisher].loaded .ea-content,[data-ea-type].loaded .ea-content{margin:1em 1em .5em 1em;padding:1em;background:rgba(0,0,0,.03);color:#505050}[data-ea-publisher].loaded .ea-content a:link,[data-ea-type].loaded .ea-content a:link{color:#505050}[data-ea-publisher].loaded .ea-content a:visited,[data-ea-type].loaded .ea-content a:visited{color:#505050}[data-ea-publisher].loaded .ea-content a:hover,[data-ea-type].loaded .ea-content a:hover{color:#373737}[data-ea-publisher].loaded .ea-content a:active,[data-ea-type].loaded .ea-content a:active{color:#373737}[data-ea-publisher].loaded .ea-content a strong,[data-ea-publisher].loaded .ea-content a b,[data-ea-type].loaded .ea-content a strong,[data-ea-type].loaded .ea-content a b{color:#088cdb}[data-ea-publisher].loaded .ea-callout a:link,[data-ea-type].loaded .ea-callout a:link{color:#6a6a6a}[data-ea-publisher].loaded .ea-callout a:visited,[data-ea-type].loaded .ea-callout a:visited{color:#6a6a6a}[data-ea-publisher].loaded .ea-callout a:hover,[data-ea-type].loaded .ea-callout a:hover{color:#505050}[data-ea-publisher].loaded .ea-callout a:active,[data-ea-type].loaded .ea-callout a:active{color:#505050}[data-ea-publisher].loaded .ea-callout a strong,[data-ea-publisher].loaded .ea-callout a b,[data-ea-type].loaded .ea-callout a strong,[data-ea-type].loaded .ea-callout a b{color:#088cdb}[data-ea-publisher].loaded .ea-callout a,[data-ea-type].loaded .ea-callout a{font-size:.8em}[data-ea-publisher].loaded.dark .ea-content,[data-ea-type].loaded.dark .ea-content{background:rgba(255,255,255,.05);color:#dcdcdc}[data-ea-publisher].loaded.dark .ea-content a:link,[data-ea-type].loaded.dark .ea-content a:link{color:#dcdcdc}[data-ea-publisher].loaded.dark .ea-content a:visited,[data-ea-type].loaded.dark .ea-content a:visited{color:#dcdcdc}[data-ea-publisher].loaded.dark .ea-content a:hover,[data-ea-type].loaded.dark .ea-content a:hover{color:#f6f6f6}[data-ea-publisher].loaded.dark .ea-content a:active,[data-ea-type].loaded.dark .ea-content a:active{color:#f6f6f6}[data-ea-publisher].loaded.dark .ea-content a strong,[data-ea-publisher].loaded.dark .ea-content a b,[data-ea-type].loaded.dark .ea-content a strong,[data-ea-type].loaded.dark .ea-content a b{color:#50baf9}[data-ea-publisher].loaded.dark .ea-callout a:link,[data-ea-type].loaded.dark .ea-callout a:link{color:#c3c3c3}[data-ea-publisher].loaded.dark .ea-callout a:visited,[data-ea-type].loaded.dark .ea-callout a:visited{color:#c3c3c3}[data-ea-publisher].loaded.dark .ea-callout a:hover,[data-ea-type].loaded.dark .ea-callout a:hover{color:#dcdcdc}[data-ea-publisher].loaded.dark .ea-callout a:active,[data-ea-type].loaded.dark .ea-callout a:active{color:#dcdcdc}[data-ea-publisher].loaded.dark .ea-callout a strong,[data-ea-publisher].loaded.dark .ea-callout a b,[data-ea-type].loaded.dark .ea-callout a strong,[data-ea-type].loaded.dark .ea-callout a b{color:#50baf9}@media(prefers-color-scheme: dark){[data-ea-publisher].loaded.adaptive .ea-content,[data-ea-type].loaded.adaptive .ea-content{background:rgba(255,255,255,.05);color:#dcdcdc}[data-ea-publisher].loaded.adaptive .ea-content a:link,[data-ea-type].loaded.adaptive .ea-content a:link{color:#dcdcdc}[data-ea-publisher].loaded.adaptive .ea-content a:visited,[data-ea-type].loaded.adaptive .ea-content a:visited{color:#dcdcdc}[data-ea-publisher].loaded.adaptive .ea-content a:hover,[data-ea-type].loaded.adaptive .ea-content a:hover{color:#f6f6f6}[data-ea-publisher].loaded.adaptive .ea-content a:active,[data-ea-type].loaded.adaptive .ea-content a:active{color:#f6f6f6}[data-ea-publisher].loaded.adaptive .ea-content a strong,[data-ea-publisher].loaded.adaptive .ea-content a b,[data-ea-type].loaded.adaptive .ea-content a strong,[data-ea-type].loaded.adaptive .ea-content a b{color:#50baf9}[data-ea-publisher].loaded.adaptive .ea-callout a:link,[data-ea-type].loaded.adaptive .ea-callout a:link{color:#c3c3c3}[data-ea-publisher].loaded.adaptive .ea-callout a:visited,[data-ea-type].loaded.adaptive .ea-callout a:visited{color:#c3c3c3}[data-ea-publisher].loaded.adaptive .ea-callout a:hover,[data-ea-type].loaded.adaptive .ea-callout a:hover{color:#dcdcdc}[data-ea-publisher].loaded.adaptive .ea-callout a:active,[data-ea-type].loaded.adaptive .ea-callout a:active{color:#dcdcdc}[data-ea-publisher].loaded.adaptive .ea-callout a strong,[data-ea-publisher].loaded.adaptive .ea-callout a b,[data-ea-type].loaded.adaptive .ea-callout a strong,[data-ea-type].loaded.adaptive .ea-callout a b{color:#50baf9}}[data-ea-publisher].loaded .ea-content,[data-ea-type].loaded .ea-content{border:0px;border-radius:3px;box-shadow:0px 2px 3px rgba(0,0,0,.15)}[data-ea-publisher].loaded.raised .ea-content,[data-ea-type].loaded.raised .ea-content{border:0px;border-radius:3px;box-shadow:0px 2px 3px rgba(0,0,0,.15)}[data-ea-publisher].loaded.bordered .ea-content,[data-ea-type].loaded.bordered .ea-content{border:1px solid rgba(0,0,0,.04);border-radius:3px;box-shadow:none}[data-ea-publisher].loaded.bordered.dark .ea-content,[data-ea-type].loaded.bordered.dark .ea-content{border:1px solid rgba(255,255,255,.07)}@media(prefers-color-scheme: dark){[data-ea-publisher].loaded.bordered.adaptive .ea-content,[data-ea-type].loaded.bordered.adaptive .ea-content{border:1px solid rgba(255,255,255,.07)}}[data-ea-publisher].loaded.flat .ea-content,[data-ea-type].loaded.flat .ea-content{border:0px;border-radius:3px;box-shadow:none}[data-ea-type=image].loaded,[data-ea-publisher]:not([data-ea-type]).loaded,.ea-type-image{display:inline-block}[data-ea-type=image].loaded .ea-content,[data-ea-publisher]:not([data-ea-type]).loaded .ea-content,.ea-type-image .ea-content{max-width:180px;overflow:auto;text-align:center}[data-ea-type=image].loaded .ea-content>a>img,[data-ea-publisher]:not([data-ea-type]).loaded .ea-content>a>img,.ea-type-image .ea-content>a>img{width:120px;height:90px;display:inline-block}[data-ea-type=image].loaded .ea-content>.ea-text,[data-ea-publisher]:not([data-ea-type]).loaded .ea-content>.ea-text,.ea-type-image .ea-content>.ea-text{margin-top:1em;font-size:1em;text-align:center}[data-ea-type=image].loaded .ea-callout,[data-ea-publisher]:not([data-ea-type]).loaded .ea-callout,.ea-type-image .ea-callout{max-width:180px;margin:0em 1em 1em 1em;padding-left:1em;padding-right:1em;font-style:italic;text-align:right}[data-ea-type=image].loaded.horizontal .ea-content,[data-ea-publisher]:not([data-ea-type]).loaded.horizontal .ea-content,.ea-type-image.horizontal .ea-content{max-width:320px}[data-ea-type=image].loaded.horizontal .ea-content>a>img,[data-ea-publisher]:not([data-ea-type]).loaded.horizontal .ea-content>a>img,.ea-type-image.horizontal .ea-content>a>img{float:left;margin-right:1em}[data-ea-type=image].loaded.horizontal .ea-content .ea-text,[data-ea-publisher]:not([data-ea-type]).loaded.horizontal .ea-content .ea-text,.ea-type-image.horizontal .ea-content .ea-text{margin-top:0em;text-align:left;overflow:auto}[data-ea-type=image].loaded.horizontal .ea-callout,[data-ea-publisher]:not([data-ea-type]).loaded.horizontal .ea-callout,.ea-type-image.horizontal .ea-callout{max-width:320px;text-align:right}[data-ea-type=text].loaded,.ea-type-text{font-size:14px}[data-ea-type=text].loaded .ea-content,.ea-type-text .ea-content{text-align:left}[data-ea-type=text].loaded .ea-callout,.ea-type-text .ea-callout{margin:.5em 1em 1em 1em;padding-left:1em;padding-right:1em;text-align:right;font-style:italic}[data-ea-style=stickybox].loaded{position:fixed;bottom:20px;right:20px;z-index:10}[data-ea-style=stickybox].loaded .ea-type-image .ea-stickybox-hide{cursor:pointer;position:absolute;top:.75em;right:.75em;background-color:#fefefe;border:1px solid #088cdb;border-radius:50%;color:#088cdb;font-size:1em;text-align:center;height:1.5em;width:1.5em;line-height:1.5em}@media(max-width: 1300px){[data-ea-style=stickybox].loaded{position:static;bottom:0;right:0;margin:auto;text-align:center}[data-ea-style=stickybox].loaded .ea-stickybox-hide{display:none}}@media(min-width: 1301px){[data-ea-style=stickybox].loaded .ea-type-image .ea-content{background:#dcdcdc}[data-ea-style=stickybox].loaded.dark .ea-type-image .ea-content{background:#505050}}@media(min-width: 1301px)and (prefers-color-scheme: dark){[data-ea-style=stickybox].loaded.adaptive .ea-type-image .ea-content{background:#505050}}[data-ea-style=fixedfooter].loaded{position:fixed;bottom:0;left:0;z-index:200;width:100%;max-width:100%}[data-ea-style=fixedfooter].loaded .ea-type-text{width:100%;max-width:100%;display:flex;z-index:200;background:#dcdcdc}[data-ea-style=fixedfooter].loaded .ea-type-text .ea-content{border:0px;border-radius:3px;box-shadow:none}[data-ea-style=fixedfooter].loaded .ea-type-text .ea-content{background-color:inherit;max-width:100%;margin:0;padding:1em;flex:auto}[data-ea-style=fixedfooter].loaded .ea-type-text .ea-callout{max-width:100%;margin:0;padding:1em;flex:initial}@media(max-width: 576px){[data-ea-style=fixedfooter].loaded .ea-type-text .ea-callout{display:none}}[data-ea-style=fixedfooter].loaded .ea-type-text .ea-fixedfooter-hide{cursor:pointer;color:#505050;padding:1em;flex:initial;margin:auto 0}[data-ea-style=fixedfooter].loaded .ea-type-text .ea-fixedfooter-hide span{padding:.25em;font-size:.8em;font-weight:bold;border:.15em solid #505050;border-radius:.5em;white-space:nowrap}[data-ea-style=fixedfooter].loaded.dark .ea-type-text{background:#505050}[data-ea-style=fixedfooter].loaded.dark .ea-type-text .ea-fixedfooter-hide span{color:#dcdcdc;border-color:#dcdcdc}@media(prefers-color-scheme: dark){[data-ea-style=fixedfooter].loaded.adaptive .ea-type-text{background:#505050}[data-ea-style=fixedfooter].loaded.adaptive .ea-type-text .ea-fixedfooter-hide span{color:#dcdcdc;border-color:#dcdcdc}}</style><script src="./Make a README_files/saved_resource" type="text/javascript" async=""></script></head><body><div id="__next"><a href="https://github.com/dguo/make-a-readme" class="github-corner" aria-label="Open GitHub project"><svg width="80" height="80" viewBox="0 0 250 250" style="position:absolute;top:0;fill:#404040;right:0"><path class="octo-banner" d="M0 0l115 115h15l12 27 108 108V0z" fill="#fff"></path><path class="octo-arm" d="M128 109c-15-9-9-19-9-19 3-7 2-11 2-11-1-7 3-2 3-2 4 5 2 11 2 11-3 10 5 15 9 16" style="-webkit-transform-origin:130px 106px;transform-origin:130px 106px"></path><path class="octo-body" d="M115 115s4 2 5 0l14-14c3-2 6-3 8-3-8-11-15-24 2-41 5-5 10-7 16-7 1-2 3-7 12-11 0 0 5 3 7 16 4 2 8 5 12 9s7 8 9 12c14 3 17 7 17 7-4 8-9 11-11 11 0 6-2 11-7 16-16 16-30 10-41 2 0 3-1 7-5 11l-12 11c-1 1 1 5 1 5z"></path></svg></a><header class="bg-gradient-to-br from-dark-gray via-medium-gray to-light-gray text-center text-white py-24"><span class="mb-6 fa-layers fa-fw fa-5x"><svg aria-hidden="true" focusable="false" data-prefix="fas" data-icon="circle" class="svg-inline--fa fa-circle " role="img" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><path fill="currentColor" d="M256 512A256 256 0 1 0 256 0a256 256 0 1 0 0 512z"></path></svg><svg aria-hidden="true" focusable="false" data-prefix="fas" data-icon="file-lines" class="svg-inline--fa fa-file-lines text-medium-gray" role="img" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 384 512" style="transform-origin:0.375em 0.5em"><g transform="translate(192 256)"><g transform="translate(0, 0) scale(0.625, 0.625) rotate(0 0 0)"><path fill="currentColor" d="M64 0C28.7 0 0 28.7 0 64V448c0 35.3 28.7 64 64 64H320c35.3 0 64-28.7 64-64V160H256c-17.7 0-32-14.3-32-32V0H64zM256 0V128H384L256 0zM112 256H272c8.8 0 16 7.2 16 16s-7.2 16-16 16H112c-8.8 0-16-7.2-16-16s7.2-16 16-16zm0 64H272c8.8 0 16 7.2 16 16s-7.2 16-16 16H112c-8.8 0-16-7.2-16-16s7.2-16 16-16zm0 64H272c8.8 0 16 7.2 16 16s-7.2 16-16 16H112c-8.8 0-16-7.2-16-16s7.2-16 16-16z" transform="translate(-192 -256)"></path></g></g></svg></span><h1 class="mb-2">Make a README</h1><p class="text-2xl">Because no one can read your mind (<a id="yet" href="https://www.makeareadme.com/#mind-reading" class="text-blue-400">yet</a>)</p></header><aside id="ethicalads-section" class="flex justify-center border-b-2 pt-2"><div class="horizontal" data-ea-publisher="makeareadmecom" data-ea-type="image"></div></aside><section class="flex justify-center pt-10 pb-6"><div class="max-w-prose"><h2 id="readme-101"><a class="anchorjs-link " href="https://www.makeareadme.com/#readme-101" aria-label="Anchor" data-anchorjs-icon="" style="font-style: normal; font-variant: normal; font-kerning: auto; font-optical-sizing: auto; font-feature-settings: normal; font-variation-settings: normal; font-weight: normal; font-stretch: normal; font-size: 1em; line-height: inherit; font-family: anchorjs-icons; position: absolute; margin-left: -1em; padding-right: 0.5em;"></a>README 101</h2><div class="mb-8 mx-4"><h3 id="what-is-it"><a class="anchorjs-link " href="https://www.makeareadme.com/#what-is-it" aria-label="Anchor" data-anchorjs-icon="" style="font-style: normal; font-variant: normal; font-kerning: auto; font-optical-sizing: auto; font-feature-settings: normal; font-variation-settings: normal; font-weight: normal; font-stretch: normal; font-size: 1em; line-height: inherit; font-family: anchorjs-icons; position: absolute; margin-left: -1em; padding-right: 0.5em;"></a>What is it?</h3><p>A<!-- --> <a href="https://en.wikipedia.org/wiki/README">README</a> <!-- -->is a text file that introduces and explains a project. It contains information that is commonly required to understand what the project is about.</p></div><div class="mb-8 mx-4"><h3 id="why-should-i-make-it"><a class="anchorjs-link " href="https://www.makeareadme.com/#why-should-i-make-it" aria-label="Anchor" data-anchorjs-icon="" style="font-style: normal; font-variant: normal; font-kerning: auto; font-optical-sizing: auto; font-feature-settings: normal; font-variation-settings: normal; font-weight: normal; font-stretch: normal; font-size: 1em; line-height: inherit; font-family: anchorjs-icons; position: absolute; margin-left: -1em; padding-right: 0.5em;"></a>Why should I make it?</h3><p>It's an easy way to answer questions that your audience will likely have regarding how to install and use your project and also how to collaborate with you.</p></div><div class="mb-8 mx-4"><h3 id="who-should-make-it"><a class="anchorjs-link " href="https://www.makeareadme.com/#who-should-make-it" aria-label="Anchor" data-anchorjs-icon="" style="font-style: normal; font-variant: normal; font-kerning: auto; font-optical-sizing: auto; font-feature-settings: normal; font-variation-settings: normal; font-weight: normal; font-stretch: normal; font-size: 1em; line-height: inherit; font-family: anchorjs-icons; position: absolute; margin-left: -1em; padding-right: 0.5em;"></a>Who should make it?</h3><p>Anyone who is working on a programming project, especially if you want others to use it or contribute.</p></div><div class="mb-8 mx-4"><h3 id="when-should-i-make-it"><a class="anchorjs-link " href="https://www.makeareadme.com/#when-should-i-make-it" aria-label="Anchor" data-anchorjs-icon="" style="font-style: normal; font-variant: normal; font-kerning: auto; font-optical-sizing: auto; font-feature-settings: normal; font-variation-settings: normal; font-weight: normal; font-stretch: normal; font-size: 1em; line-height: inherit; font-family: anchorjs-icons; position: absolute; margin-left: -1em; padding-right: 0.5em;"></a>When should I make it?</h3><p>Definitely before you show a project to other people or make it public. You might want to get into the habit of making it the<!-- --> <a href="http://tom.preston-werner.com/2010/08/23/readme-driven-development.html">first file you create</a> <!-- -->in a new project.</p></div><div class="mb-8 mx-4"><h3 id="where-should-i-put-it"><a class="anchorjs-link " href="https://www.makeareadme.com/#where-should-i-put-it" aria-label="Anchor" data-anchorjs-icon="" style="font-style: normal; font-variant: normal; font-kerning: auto; font-optical-sizing: auto; font-feature-settings: normal; font-variation-settings: normal; font-weight: normal; font-stretch: normal; font-size: 1em; line-height: inherit; font-family: anchorjs-icons; position: absolute; margin-left: -1em; padding-right: 0.5em;"></a>Where should I put it?</h3><p>In the top level directory of the project. This is where someone who is new to your project will start out. Code hosting services such as<!-- --> <a href="https://github.com/">GitHub</a>,<!-- --> <a href="https://bitbucket.org/">Bitbucket</a>, and<!-- --> <a href="https://about.gitlab.com/">GitLab</a> will also look for your README and display it along with the list of files and directories in your project.</p></div><div class="mb-8 mx-4"><h3 id="how-should-i-make-it"><a class="anchorjs-link " href="https://www.makeareadme.com/#how-should-i-make-it" aria-label="Anchor" data-anchorjs-icon="" style="font-style: normal; font-variant: normal; font-kerning: auto; font-optical-sizing: auto; font-feature-settings: normal; font-variation-settings: normal; font-weight: normal; font-stretch: normal; font-size: 1em; line-height: inherit; font-family: anchorjs-icons; position: absolute; margin-left: -1em; padding-right: 0.5em;"></a>How should I make it?</h3><p>While READMEs can be written in any text file format, the most common one that is used nowadays is<!-- --> <a href="https://en.wikipedia.org/wiki/Markdown">Markdown</a>. It allows you to add some lightweight formatting. You can learn more about it at the<!-- --> <a href="https://commonmark.org/">CommonMark website</a>, which also has a helpful<!-- --> <a href="https://commonmark.org/help/">reference guide</a> <!-- -->and an<!-- --> <a href="https://commonmark.org/help/tutorial/">interactive tutorial</a>.</p><p>Some other formats that you might see are<!-- --> <a href="https://en.wikipedia.org/wiki/Text_file">plain text</a>,<!-- --> <a href="https://en.wikipedia.org/wiki/ReStructuredText">reStructuredText</a> <!-- -->(common in <a href="https://www.python.org/">Python</a> <!-- -->projects), and<!-- --> <a href="https://en.wikipedia.org/wiki/Textile_(markup_language)">Textile</a>.</p><p>You can use any text editor. There are plugins for many editors (e.g.<!-- --> <a href="https://github.com/atom/markdown-preview">Atom</a>,<!-- --> <a href="https://github.com/jrblevin/markdown-mode">Emacs</a>,<!-- --> <a href="https://github.com/revolunet/sublimetext-markdown-preview">Sublime Text</a>,<!-- --> <a href="https://github.com/suan/vim-instant-markdown">Vim</a>, and<!-- --> <a href="https://code.visualstudio.com/docs/languages/markdown#_markdown-preview">Visual Studio Code</a>) that allow you to preview Markdown while you are editing it.</p><p>You can also use a dedicated Markdown editor like<!-- --> <a href="https://typora.io/">Typora</a> or an online one like <a href="https://stackedit.io/app">StackEdit</a> or<!-- --> <a href="http://dillinger.io/">Dillinger</a>. You can even use the editable template below.</p></div></div></section><section id="template" class="bg-medium-gray pb-10"><h2 class="text-white pt-10" id="template-1"><a class="anchorjs-link " href="https://www.makeareadme.com/#template-1" aria-label="Anchor" data-anchorjs-icon="" style="font-style: normal; font-variant: normal; font-kerning: auto; font-optical-sizing: auto; font-feature-settings: normal; font-variation-settings: normal; font-weight: normal; font-stretch: normal; font-size: 1em; line-height: inherit; font-family: anchorjs-icons; position: absolute; margin-left: -1em; padding-right: 0.5em;"></a>Template</h2><div class="flex justify-center flex-wrap"><div class="flex-1 m-3 max-w-5xl"><p class="text-white text-center text-xl font-bold mt-0 mb-4"><label for="markdown-input">Markdown Input (editable)</label></p><textarea id="markdown-input" class="bg-white w-full px-4 py-6 rounded-lg font-mono text-sm" style="height: 388px !important;"># Introduction
Markdown Content Viewer is created to ease users with the generating of the markdown files. It reads from the folder and directly produces the markdown content. It eliminates the need to copy contents of the file to a markdown editor
## Installation
Requires .Net 7.0 sdk and runtime to run.
Visual Studio Community is required.
There is no extra javascript libraries except than the one bundled with the solution file.
## Usage
Build and the solution would run accordingly.
## Testing
Extra md files can be added to this path
'..\MarkdownViewer\MarkdownViewer\wwwroot\Files' to test the functionality of the system.</textarea></div><div class="flex-1 m-3 max-w-5xl"><p class="text-white text-center text-xl font-bold mt-0 mb-4">Rendered</p><div id="rendered" class="markdown-body bg-white p-4 rounded-lg"><h1>Introduction</h1>
<p>Markdown Content Viewer is created to ease users with the generating of the markdown files. It reads from the folder and directly produces the markdown content. It eliminates the need to copy contents of the file to a markdown editor</p>
<h2 id="installation"><a class="anchorjs-link " href="https://www.makeareadme.com/#installation" aria-label="Anchor" data-anchorjs-icon="" style="font-style: normal; font-variant: normal; font-kerning: auto; font-optical-sizing: auto; font-feature-settings: normal; font-variation-settings: normal; font-weight: normal; font-stretch: normal; font-size: 1em; line-height: inherit; font-family: anchorjs-icons; position: absolute; margin-left: -1em; padding-right: 0.5em;"></a>Installation</h2>
<p>Requires .Net 7.0 sdk and runtime to run.
Visual Studio Community is required.
There is no extra javascript libraries except than the one bundled with the solution file.</p>
<h2 id="usage"><a class="anchorjs-link " href="https://www.makeareadme.com/#usage" aria-label="Anchor" data-anchorjs-icon="" style="font-style: normal; font-variant: normal; font-kerning: auto; font-optical-sizing: auto; font-feature-settings: normal; font-variation-settings: normal; font-weight: normal; font-stretch: normal; font-size: 1em; line-height: inherit; font-family: anchorjs-icons; position: absolute; margin-left: -1em; padding-right: 0.5em;"></a>Usage</h2>
<p>Build and the solution would run accordingly.</p>
<h2>Testing</h2>
<p>Extra md files can be added to this path
'..\MarkdownViewer\MarkdownViewer\wwwroot\Files' to test the functionality of the system.</p></div></div></div></section><section class="flex justify-center pt-10 pb-6"><div class="max-w-prose"><h2 id="suggestions-for-a-good-readme"><a class="anchorjs-link " href="https://www.makeareadme.com/#suggestions-for-a-good-readme" aria-label="Anchor" data-anchorjs-icon="" style="font-style: normal; font-variant: normal; font-kerning: auto; font-optical-sizing: auto; font-feature-settings: normal; font-variation-settings: normal; font-weight: normal; font-stretch: normal; font-size: 1em; line-height: inherit; font-family: anchorjs-icons; position: absolute; margin-left: -1em; padding-right: 0.5em;"></a>Suggestions for a good README</h2><p class="mb-8 mx-4">Every project is different, so consider which of these sections apply to yours. The sections used in the template are suggestions for most open source projects. Also keep in mind that while a README can be too long and detailed, too long is better than too short. If you think your README is too long, consider utilizing<!-- --> <a href="https://www.makeareadme.com/#more-documentation">another form of documentation</a> <!-- -->rather than cutting out information.</p><div class="mb-8 mx-4"><h3 id="name"><a class="anchorjs-link " href="https://www.makeareadme.com/#name" aria-label="Anchor" data-anchorjs-icon="" style="font-style: normal; font-variant: normal; font-kerning: auto; font-optical-sizing: auto; font-feature-settings: normal; font-variation-settings: normal; font-weight: normal; font-stretch: normal; font-size: 1em; line-height: inherit; font-family: anchorjs-icons; position: absolute; margin-left: -1em; padding-right: 0.5em;"></a>Name</h3><p>Choose a self-explaining name for your project.</p></div><div class="mb-8 mx-4"><h3 id="description"><a class="anchorjs-link " href="https://www.makeareadme.com/#description" aria-label="Anchor" data-anchorjs-icon="" style="font-style: normal; font-variant: normal; font-kerning: auto; font-optical-sizing: auto; font-feature-settings: normal; font-variation-settings: normal; font-weight: normal; font-stretch: normal; font-size: 1em; line-height: inherit; font-family: anchorjs-icons; position: absolute; margin-left: -1em; padding-right: 0.5em;"></a>Description</h3><p>Let people know what your project can do specifically. Provide context and add a link to any reference visitors might be unfamiliar with. A list of <b>Features</b> or a<!-- --> <b>Background</b> subsection can also be added here. If there are alternatives to your project, this is a good place to list differentiating factors.</p></div><div class="mb-8 mx-4"><h3 id="badges"><a class="anchorjs-link " href="https://www.makeareadme.com/#badges" aria-label="Anchor" data-anchorjs-icon="" style="font-style: normal; font-variant: normal; font-kerning: auto; font-optical-sizing: auto; font-feature-settings: normal; font-variation-settings: normal; font-weight: normal; font-stretch: normal; font-size: 1em; line-height: inherit; font-family: anchorjs-icons; position: absolute; margin-left: -1em; padding-right: 0.5em;"></a>Badges</h3><p>On some READMEs, you may see small images that convey metadata, such as whether or not all the tests are passing for the project. You can use<!-- --> <a href="http://shields.io/">Shields</a> to add some to your README. Many services also have instructions for adding a badge.</p></div><div class="mb-8 mx-4"><h3 id="visuals"><a class="anchorjs-link " href="https://www.makeareadme.com/#visuals" aria-label="Anchor" data-anchorjs-icon="" style="font-style: normal; font-variant: normal; font-kerning: auto; font-optical-sizing: auto; font-feature-settings: normal; font-variation-settings: normal; font-weight: normal; font-stretch: normal; font-size: 1em; line-height: inherit; font-family: anchorjs-icons; position: absolute; margin-left: -1em; padding-right: 0.5em;"></a>Visuals</h3><p>Depending on what you are making, it can be a good idea to include screenshots or even a video (you'll frequently see GIFs rather than actual videos). Tools like<!-- --> <a href="https://github.com/icholy/ttygif">ttygif</a> <!-- -->can help, but check out<!-- --> <a href="https://asciinema.org/">Asciinema</a> for a more sophisticated method.</p></div><div class="mb-8 mx-4"><h3 id="installation-1"><a class="anchorjs-link " href="https://www.makeareadme.com/#installation-1" aria-label="Anchor" data-anchorjs-icon="" style="font-style: normal; font-variant: normal; font-kerning: auto; font-optical-sizing: auto; font-feature-settings: normal; font-variation-settings: normal; font-weight: normal; font-stretch: normal; font-size: 1em; line-height: inherit; font-family: anchorjs-icons; position: absolute; margin-left: -1em; padding-right: 0.5em;"></a>Installation</h3><p>Within a particular ecosystem, there may be a common way of installing things, such as using<!-- --> <a href="https://yarnpkg.com/">Yarn</a>,<!-- --> <a href="https://www.nuget.org/">NuGet</a>, or<!-- --> <a href="https://brew.sh/">Homebrew</a>. However, consider the possibility that whoever is reading your README is a novice and would like more guidance. Listing specific steps helps remove ambiguity and gets people to using your project as quickly as possible. If it only runs in a specific context like a particular programming language version or operating system or has dependencies that have to be installed manually, also add a<!-- --> <b>Requirements</b> subsection.</p></div><div class="mb-8 mx-4"><h3 id="usage-1"><a class="anchorjs-link " href="https://www.makeareadme.com/#usage-1" aria-label="Anchor" data-anchorjs-icon="" style="font-style: normal; font-variant: normal; font-kerning: auto; font-optical-sizing: auto; font-feature-settings: normal; font-variation-settings: normal; font-weight: normal; font-stretch: normal; font-size: 1em; line-height: inherit; font-family: anchorjs-icons; position: absolute; margin-left: -1em; padding-right: 0.5em;"></a>Usage</h3><p>Use examples liberally, and show the expected output if you can. It's helpful to have inline the smallest example of usage that you can demonstrate, while providing links to more sophisticated examples if they are too long to reasonably include in the README.</p></div><div class="mb-8 mx-4"><h3 id="support"><a class="anchorjs-link " href="https://www.makeareadme.com/#support" aria-label="Anchor" data-anchorjs-icon="" style="font-style: normal; font-variant: normal; font-kerning: auto; font-optical-sizing: auto; font-feature-settings: normal; font-variation-settings: normal; font-weight: normal; font-stretch: normal; font-size: 1em; line-height: inherit; font-family: anchorjs-icons; position: absolute; margin-left: -1em; padding-right: 0.5em;"></a>Support</h3><p>Tell people where they can go to for help. It can be any combination of an issue tracker, a chat room, an email address, etc.</p></div><div class="mb-8 mx-4"><h3 id="roadmap"><a class="anchorjs-link " href="https://www.makeareadme.com/#roadmap" aria-label="Anchor" data-anchorjs-icon="" style="font-style: normal; font-variant: normal; font-kerning: auto; font-optical-sizing: auto; font-feature-settings: normal; font-variation-settings: normal; font-weight: normal; font-stretch: normal; font-size: 1em; line-height: inherit; font-family: anchorjs-icons; position: absolute; margin-left: -1em; padding-right: 0.5em;"></a>Roadmap</h3><p>If you have ideas for releases in the future, it is a good idea to list them in the README.</p></div><div class="mb-8 mx-4"><h3 id="contributing-1"><a class="anchorjs-link " href="https://www.makeareadme.com/#contributing-1" aria-label="Anchor" data-anchorjs-icon="" style="font-style: normal; font-variant: normal; font-kerning: auto; font-optical-sizing: auto; font-feature-settings: normal; font-variation-settings: normal; font-weight: normal; font-stretch: normal; font-size: 1em; line-height: inherit; font-family: anchorjs-icons; position: absolute; margin-left: -1em; padding-right: 0.5em;"></a>Contributing</h3><p>State if you are open to contributions and what your requirements are for accepting them.</p><p>For people who want to make changes to your project, it's helpful to have some documentation on how to get started. Perhaps there is a script that they should run or some environment variables that they need to set. Make these steps explicit. These instructions could also be useful to your future self.</p><p>You can also document commands to<!-- --> <a href="https://stackoverflow.com/questions/8503559/what-is-linting">lint the code</a> <!-- -->or<!-- --> <a href="https://en.wikipedia.org/wiki/Test_automation">run tests</a>. These steps help to ensure high code quality and reduce the likelihood that the changes inadvertently break something. Having instructions for running tests is especially helpful if it requires external setup, such as starting a<!-- --> <a href="http://www.seleniumhq.org/">Selenium</a> server for testing in a browser.</p></div><div class="mb-8 mx-4"><h3 id="authors-and-acknowledgment"><a class="anchorjs-link " href="https://www.makeareadme.com/#authors-and-acknowledgment" aria-label="Anchor" data-anchorjs-icon="" style="font-style: normal; font-variant: normal; font-kerning: auto; font-optical-sizing: auto; font-feature-settings: normal; font-variation-settings: normal; font-weight: normal; font-stretch: normal; font-size: 1em; line-height: inherit; font-family: anchorjs-icons; position: absolute; margin-left: -1em; padding-right: 0.5em;"></a>Authors and acknowledgment</h3><p>Show your appreciation to those who have contributed to the project.</p></div><div class="mb-8 mx-4"><h3 id="license-1"><a class="anchorjs-link " href="https://www.makeareadme.com/#license-1" aria-label="Anchor" data-anchorjs-icon="" style="font-style: normal; font-variant: normal; font-kerning: auto; font-optical-sizing: auto; font-feature-settings: normal; font-variation-settings: normal; font-weight: normal; font-stretch: normal; font-size: 1em; line-height: inherit; font-family: anchorjs-icons; position: absolute; margin-left: -1em; padding-right: 0.5em;"></a>License</h3><p>For open source projects, say how it is<!-- --> <a href="https://www.makeareadme.com/#license-1">licensed</a>.</p></div><div class="mb-8 mx-4"><h3 id="project-status"><a class="anchorjs-link " href="https://www.makeareadme.com/#project-status" aria-label="Anchor" data-anchorjs-icon="" style="font-style: normal; font-variant: normal; font-kerning: auto; font-optical-sizing: auto; font-feature-settings: normal; font-variation-settings: normal; font-weight: normal; font-stretch: normal; font-size: 1em; line-height: inherit; font-family: anchorjs-icons; position: absolute; margin-left: -1em; padding-right: 0.5em;"></a>Project status</h3><p>If you have run out of energy or time for your project, put a note at the top of the README saying that development has slowed down or stopped completely. Someone may choose to fork your project or volunteer to step in as a maintainer or owner, allowing your project to keep going. You can also make an explicit request for maintainers.</p></div></div></section><section id="faq" class="flex justify-center pt-10 pb-6 bg-medium-gray"><div class="max-w-prose"><h2 class="text-white" id="faq-1"><a class="anchorjs-link " href="https://www.makeareadme.com/#faq-1" aria-label="Anchor" data-anchorjs-icon="" style="font-style: normal; font-variant: normal; font-kerning: auto; font-optical-sizing: auto; font-feature-settings: normal; font-variation-settings: normal; font-weight: normal; font-stretch: normal; font-size: 1em; line-height: inherit; font-family: anchorjs-icons; position: absolute; margin-left: -1em; padding-right: 0.5em;"></a>FAQ</h2><div class="mb-8 mx-4"><h3 class="bg-yellow-300 px-6 py-3 mb-0 rounded-t-md text-lg" id="is-there-a-standard-readme-format"><a class="anchorjs-link " href="https://www.makeareadme.com/#is-there-a-standard-readme-format" aria-label="Anchor" data-anchorjs-icon="" style="font-style: normal; font-variant: normal; font-kerning: auto; font-optical-sizing: auto; font-feature-settings: normal; font-variation-settings: normal; font-weight: normal; font-stretch: normal; font-size: 1em; line-height: inherit; font-family: anchorjs-icons; position: absolute; margin-left: -1em; padding-right: 0.5em;"></a>Is there a standard README format?</h3><div class="bg-yellow-50 px-6 pt-2 pb-4 rounded-b-md"><p>Not all of the suggestions here will make sense for every project, so it's really up to the developers what information should be included in the README.</p></div></div><div class="mb-8 mx-4"><h3 class="bg-yellow-300 px-6 py-3 mb-0 rounded-t-md text-lg" id="what-are-some-other-thoughts-on-writing-readmes"><a class="anchorjs-link " href="https://www.makeareadme.com/#what-are-some-other-thoughts-on-writing-readmes" aria-label="Anchor" data-anchorjs-icon="" style="font-style: normal; font-variant: normal; font-kerning: auto; font-optical-sizing: auto; font-feature-settings: normal; font-variation-settings: normal; font-weight: normal; font-stretch: normal; font-size: 1em; line-height: inherit; font-family: anchorjs-icons; position: absolute; margin-left: -1em; padding-right: 0.5em;"></a>What are some other thoughts on writing READMEs?</h3><div class="bg-yellow-50 px-6 pt-2 pb-4 rounded-b-md"><p>Check out<!-- --> <a href="https://github.com/matiassingers/awesome-readme">Awesome README</a> <!-- -->for a list of more resources.</p></div></div><div class="mb-8 mx-4"><h3 class="bg-yellow-300 px-6 py-3 mb-0 rounded-t-md text-lg" id="what-should-the-readme-file-be-named"><a class="anchorjs-link " href="https://www.makeareadme.com/#what-should-the-readme-file-be-named" aria-label="Anchor" data-anchorjs-icon="" style="font-style: normal; font-variant: normal; font-kerning: auto; font-optical-sizing: auto; font-feature-settings: normal; font-variation-settings: normal; font-weight: normal; font-stretch: normal; font-size: 1em; line-height: inherit; font-family: anchorjs-icons; position: absolute; margin-left: -1em; padding-right: 0.5em;"></a>What should the README file be named?</h3><div class="bg-yellow-50 px-6 pt-2 pb-4 rounded-b-md"><p><code>README.md</code> (or a different file extension if you choose to use a non-Markdown file format). It is<!-- --> <a href="https://softwareengineering.stackexchange.com/q/301691/298927">traditionally uppercase</a> <!-- -->so that it is more prominent, but it's not a big deal if you think it<!-- --> <a href="https://github.com/sindresorhus/ama/issues/197">looks better lowercase</a>.</p></div></div><div class="mb-8 mx-4"><h3 class="bg-yellow-300 px-6 py-3 mb-0 rounded-t-md text-lg" id="what-if-i-disagree-with-something-want-to-make-a-c"><a class="anchorjs-link " href="https://www.makeareadme.com/#what-if-i-disagree-with-something-want-to-make-a-c" aria-label="Anchor" data-anchorjs-icon="" style="font-style: normal; font-variant: normal; font-kerning: auto; font-optical-sizing: auto; font-feature-settings: normal; font-variation-settings: normal; font-weight: normal; font-stretch: normal; font-size: 1em; line-height: inherit; font-family: anchorjs-icons; position: absolute; margin-left: -1em; padding-right: 0.5em;"></a>What if I disagree with something, want to make a change, or have any other feedback?</h3><div class="bg-yellow-50 px-6 pt-2 pb-4 rounded-b-md"><p>Please don't hesitate to open an<!-- --> <a href="https://github.com/dguo/make-a-readme/issues">issue</a> <!-- -->or<!-- --> <a href="https://github.com/dguo/make-a-readme/pulls">pull request</a>. You can also send me a message on<!-- --> <a href="https://twitter.com/dannyguo">Twitter</a>.</p></div></div><div class="mb-8 mx-4"><h3 class="bg-yellow-300 px-6 py-3 mb-0 rounded-t-md text-lg" id="mind-reading"><a class="anchorjs-link " href="https://www.makeareadme.com/#mind-reading" aria-label="Anchor" data-anchorjs-icon="" style="font-style: normal; font-variant: normal; font-kerning: auto; font-optical-sizing: auto; font-feature-settings: normal; font-variation-settings: normal; font-weight: normal; font-stretch: normal; font-size: 1em; line-height: inherit; font-family: anchorjs-icons; position: absolute; margin-left: -1em; padding-right: 0.5em;"></a>Mind reading?</h3><div class="bg-yellow-50 px-6 pt-2 pb-4 rounded-b-md"><p><a href="https://www.usatoday.com/story/tech/2014/04/22/mind-reading-brain-scans/7747831/">Scientists</a> <!-- -->and companies like<!-- --> <a href="https://www.theverge.com/2017/4/20/15375176/facebook-regina-dugan-interview-building-8-mind-reading-f8-2017">Facebook</a> <!-- -->and<!-- --> <a href="https://www.neuralink.com/">Neuralink</a> <!-- -->(presumably) are working on it. Perhaps in the future, you'll be able to attach a copy of your thoughts and/or consciousness to your projects. In the meantime, please make READMEs.</p></div></div></div></section><section class="flex justify-center pt-10 pb-6"><div class="max-w-prose"><h2 id="whats-next"><a class="anchorjs-link " href="https://www.makeareadme.com/#whats-next" aria-label="Anchor" data-anchorjs-icon="" style="font-style: normal; font-variant: normal; font-kerning: auto; font-optical-sizing: auto; font-feature-settings: normal; font-variation-settings: normal; font-weight: normal; font-stretch: normal; font-size: 1em; line-height: inherit; font-family: anchorjs-icons; position: absolute; margin-left: -1em; padding-right: 0.5em;"></a>What's next?</h2><div class="mb-8 mx-4"><h3 id="more-documentation"><a class="anchorjs-link " href="https://www.makeareadme.com/#more-documentation" aria-label="Anchor" data-anchorjs-icon="" style="font-style: normal; font-variant: normal; font-kerning: auto; font-optical-sizing: auto; font-feature-settings: normal; font-variation-settings: normal; font-weight: normal; font-stretch: normal; font-size: 1em; line-height: inherit; font-family: anchorjs-icons; position: absolute; margin-left: -1em; padding-right: 0.5em;"></a>More Documentation</h3><p>A README is a crucial but basic way of documenting your project. While every project should at least have a README, more involved ones can also benefit from a<!-- --> <a href="https://en.wikipedia.org/wiki/Wiki">wiki</a> or a dedicated documentation website.<!-- --> <a href="https://help.github.com/articles/about-github-wikis/">GitHub</a>,<!-- --> <a href="https://confluence.atlassian.com/bitbucket/use-a-wiki-221449748.html">Bitbucket</a>, and<!-- --> <a href="https://docs.gitlab.com/ce/user/project/wiki/index.html">GitLab</a> <!-- -->all support maintaining a wiki alongside your project, and here are some tools and services that can help you generate a documentation website:</p><ul class="list-disc ml-8 my-4 space-y-3"><li><a href="https://dauxio.github.io/">Daux.io</a></li><li><a href="https://docusaurus.io/">Docusaurus</a></li><li><a href="https://www.gitbook.com/">GitBook</a></li><li><a href="https://www.mkdocs.org/">MkDocs</a></li><li><a href="https://readthedocs.org/">Read the Docs</a></li><li><a href="https://readme.io/">ReadMe</a></li><li><a href="https://github.com/lord/slate">Slate</a></li><li><a href="https://docsify.js.org/">Docsify</a></li></ul><p>And to learn more about technical documentation in general, consider reading these books (I may earn commissions if you buy through these links):</p><ul class="list-disc ml-8 my-4 space-y-3"><li><a href="https://www.amazon.com/Docs-Developers-Engineers-Technical-Writing/dp/1484272161?crid=3UFJEYT8RH8YE&keywords=docs+for+developers&qid=1693139345&sprefix=docs+for+developers%2Caps%2C388&sr=8-1&linkCode=ll1&tag=makeareadme-20&linkId=2a9cf45448f33a4b8445aff149d1b1de&language=en_US&ref_=as_li_ss_tl">Docs for Developers: An Engineer’s Field Guide to Technical Writing</a></li><li><a href="https://www.amazon.com/Developing-Quality-Technical-Information-Handbook/dp/0133118975?crid=H49KJII3EIZ0&keywords=Developing+Quality+Technical+Information&qid=1693139665&sprefix=developing+quality+technical+information%2Caps%2C119&sr=8-1&linkCode=ll1&tag=makeareadme-20&linkId=98fdee518cca91c599b15bad8c4f8dd0&language=en_US&ref_=as_li_ss_tl">Developing Quality Technical Information: A Handbook for Writers and Editors</a></li><li><a href="https://www.amazon.com/Docs-Like-Code-Collaborate-Documentation/dp/1387531492?crid=YXD5PKZUVZOU&keywords=docs+like+code&qid=1693139906&sprefix=docs+like+co%2Caps%2C340&sr=8-1&linkCode=ll1&tag=makeareadme-20&linkId=452497692487d954ffb6531d6352bfcc&language=en_US&ref_=as_li_ss_tl">Docs Like Code: Collaborate and Automate to Improve Technical Documentation</a></li><li><a href="https://www.amazon.com/Product-Docs-technical-documentation-development/dp/B085KK6G8F?_encoding=UTF8&qid=1693139996&sr=8-1&linkCode=ll1&tag=makeareadme-20&linkId=dd5ac7674a48797a69c3f7fd51a72b80&language=en_US&ref_=as_li_ss_tl">The Product is Docs: Writing Technical Documentation in a Product Development Group</a></li></ul></div><div class="mb-8 mx-4"><h3 id="license-2"><a class="anchorjs-link " href="https://www.makeareadme.com/#license-2" aria-label="Anchor" data-anchorjs-icon="" style="font-style: normal; font-variant: normal; font-kerning: auto; font-optical-sizing: auto; font-feature-settings: normal; font-variation-settings: normal; font-weight: normal; font-stretch: normal; font-size: 1em; line-height: inherit; font-family: anchorjs-icons; position: absolute; margin-left: -1em; padding-right: 0.5em;"></a>License</h3><p>If your project is<!-- --> <a href="https://en.wikipedia.org/wiki/Open-source_software">open source</a>, it's<!-- --> <a href="https://blog.codinghorror.com/pick-a-license-any-license/">important</a> <!-- -->to include a<!-- --> <a href="https://en.wikipedia.org/wiki/Open-source_license">license</a>. You can use<!-- --> <a href="https://choosealicense.com/">this website</a> <!-- -->to help you pick one.</p></div><div class="mb-8 mx-4"><h3 id="changelog"><a class="anchorjs-link " href="https://www.makeareadme.com/#changelog" aria-label="Anchor" data-anchorjs-icon="" style="font-style: normal; font-variant: normal; font-kerning: auto; font-optical-sizing: auto; font-feature-settings: normal; font-variation-settings: normal; font-weight: normal; font-stretch: normal; font-size: 1em; line-height: inherit; font-family: anchorjs-icons; position: absolute; margin-left: -1em; padding-right: 0.5em;"></a>Changelog</h3><p>Make a README is inspired by<!-- --> <a href="http://keepachangelog.com/">Keep a Changelog</a>. A<!-- --> <a href="https://en.wikipedia.org/wiki/Changelog">changelog</a> <!-- -->is another file that is very useful for programming projects.</p></div><div class="mb-8 mx-4"><h3 id="contributing-2"><a class="anchorjs-link " href="https://www.makeareadme.com/#contributing-2" aria-label="Anchor" data-anchorjs-icon="" style="font-style: normal; font-variant: normal; font-kerning: auto; font-optical-sizing: auto; font-feature-settings: normal; font-variation-settings: normal; font-weight: normal; font-stretch: normal; font-size: 1em; line-height: inherit; font-family: anchorjs-icons; position: absolute; margin-left: -1em; padding-right: 0.5em;"></a>Contributing</h3><p>Just having a "Contributing" section in your README is a good start. Another approach is to split off your guidelines into their own file (<code>CONTRIBUTING.md</code>). If you use GitHub and have this file, then anyone who creates an issue or opens a pull request<!-- --> <a href="https://help.github.com/articles/setting-guidelines-for-repository-contributors/">will get a link</a> <!-- -->to it.</p><p>You can also create an<!-- --> <a href="https://help.github.com/articles/creating-an-issue-template-for-your-repository/">issue template</a> <!-- -->and a<!-- --> <a href="https://help.github.com/articles/creating-a-pull-request-template-for-your-repository/">pull request template</a>. These files give your users and collaborators templates to fill in with the information that you'll need to properly respond. This helps to avoid situations like getting very vague issues. Both GitHub and<!-- --> <a href="https://docs.gitlab.com/ce/user/project/description_templates.html">GitLab</a> <!-- -->will use the templates automatically.</p></div></div></section><footer class="flex justify-center bg-gray-100 pt-2 pb-5"><div class="max-w-prose px-4"><p>Make a README is maintained by<!-- --> <a href="https://dannyguo.com/">Danny Guo</a>, hosted on<!-- --> <a href="https://github.com/dguo/make-a-readme">GitHub</a> <!-- -->with a<!-- --> <a href="https://github.com/dguo/make-a-readme/blob/main/LICENSE">MIT license</a>, and powered by<!-- --> <a href="https://www.netlify.com/">Netlify</a>.</p><p>As an Amazon Associate, I earn from qualifying purchases.</p></div></footer></div><script id="__NEXT_DATA__" type="application/json" crossorigin="">{"props":{"pageProps":{}},"page":"/","query":{},"buildId":"55dT7kKt8tG8Ue33GTiWG","nextExport":true,"autoExport":true,"isFallback":false,"scriptLoader":[]}</script><textarea tabindex="-1" aria-hidden="true" style="min-height: 0px !important; max-height: none !important; height: 0px !important; visibility: hidden !important; overflow: hidden !important; position: absolute !important; z-index: -1000 !important; top: 0px !important; right: 0px !important; border-width: 0px; box-sizing: border-box; font-family: ui-monospace, SFMono-Regular, Menlo, Monaco, Consolas, "Liberation Mono", "Courier New", monospace; font-size: 14px; font-style: normal; font-weight: 400; letter-spacing: normal; line-height: 20px; padding: 24px 16px; tab-size: 4; text-indent: 0px; text-rendering: auto; text-transform: none; width: 821.333px; word-break: normal;"></textarea><script data-nscript="afterInteractive">
window.anchors.options.placement = "left";
// One of the longer FAQ questions doesn't work with the default
// truncate value. The anchor link looks fine, but Chrome doesn't
// jump to it when loading in a new tab.
window.anchors.options.truncate = 50;
window.anchors.add();
window.dataLayer = window.dataLayer || [];
function gtag() {
dataLayer.push(arguments);
}
gtag("js", new Date());
gtag("config", "G-2BK72SW7BH");
</script><script src="./Make a README_files/ethicalads.min.js.download" data-nscript="afterInteractive"></script><script src="./Make a README_files/script.js.download" data-api="/lava-cake/api/event" data-domain="makeareadme.com" data-nscript="afterInteractive"></script><script src="./Make a README_files/js" data-nscript="afterInteractive"></script><next-route-announcer><p aria-live="assertive" id="__next-route-announcer__" role="alert" style="border: 0px; clip: rect(0px, 0px, 0px, 0px); height: 1px; margin: -1px; overflow: hidden; padding: 0px; position: absolute; top: 0px; width: 1px; white-space: nowrap; overflow-wrap: normal;"></p></next-route-announcer></body></html>