Skip to content

Commit d47df6e

Browse files
committed
deploy: da477d2
1 parent 698c37c commit d47df6e

File tree

5 files changed

+23
-17
lines changed

5 files changed

+23
-17
lines changed

.doctrees/environment.pickle

3.73 KB
Binary file not shown.
1.93 KB
Binary file not shown.

_sources/tutorials/add-readme.md.txt

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -221,11 +221,14 @@ You can also add any links to tutorials in your documentation here.
221221

222222
## Community
223223

224-
Add information here about contributing to your package. Be sure to add links to your `CODE_OF_CONDUCT.md` file and your development guide. For now this section might be empty. You can go back and fill it in later.
224+
Add information here about contributing to your package. Be sure to add links to your
225+
`CODE_OF_CONDUCT.md` file and your development guide. For now this section might be
226+
empty. You can go back and fill it in later.
225227

226228
## How to cite pyosPackage
227229

228230
citation information here
231+
````
229232

230233
## <i class="fa-solid fa-hands-bubbles"></i> Wrap up
231234

searchindex.js

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

tutorials/add-readme.html

Lines changed: 18 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -721,28 +721,30 @@ <h2>The finished README file<a class="headerlink" href="#the-finished-readme-fil
721721

722722
<span class="gu">## Community</span>
723723

724-
Add information here about contributing to your package. Be sure to add links to your <span class="sb">`CODE_OF_CONDUCT.md`</span> file and your development guide. For now this section might be empty. You can go back and fill it in later.
724+
Add information here about contributing to your package. Be sure to add links to your
725+
<span class="sb">`CODE_OF_CONDUCT.md`</span> file and your development guide. For now this section might be
726+
empty. You can go back and fill it in later.
725727

726728
<span class="gu">## How to cite pyosPackage</span>
727729

728730
citation information here
729-
730-
<span class="gu">## &lt;i class=&quot;fa-solid fa-hands-bubbles&quot;&gt;&lt;/i&gt; Wrap up</span>
731-
732-
It&#39;s important to consider the information that a new user or contributor might
733-
need when creating your <span class="sb">`README.md`</span> file. While there is no perfect template,
731+
</pre></div>
732+
</div>
733+
</section>
734+
<section id="wrap-up">
735+
<h2><i class="fa-solid fa-hands-bubbles"></i> Wrap up<a class="headerlink" href="#wrap-up" title="Link to this heading">#</a></h2>
736+
<p>It’s important to consider the information that a new user or contributor might
737+
need when creating your <code class="docutils literal notranslate"><span class="pre">README.md</span></code> file. While there is no perfect template,
734738
above is a set of recommendations as you are just getting started. You may find
735739
the need for other elements to be added to this file as you further develop your
736-
package and as a community begins to use your package.
737-
738-
In the [<span class="nt">next lesson</span>](<span class="na">add-license-coc.md</span>), you will add a LICENSE file to
740+
package and as a community begins to use your package.</p>
741+
<p>In the <a class="reference internal" href="add-license-coc.html"><span class="std std-doc">next lesson</span></a>, you will add a LICENSE file to
739742
your Python package. A license file is critical as it tells users
740-
how they legally can (and can&#39;t) use your package. It also:
741-
742-
<span class="k">*</span><span class="w"> </span>Builds trust with your users
743-
<span class="k">*</span><span class="w"> </span>Discourages misuse of your package and associated code
744-
</pre></div>
745-
</div>
743+
how they legally can (and can’t) use your package. It also:</p>
744+
<ul class="simple">
745+
<li><p>Builds trust with your users</p></li>
746+
<li><p>Discourages misuse of your package and associated code</p></li>
747+
</ul>
746748
</section>
747749
</section>
748750

@@ -804,6 +806,7 @@ <h2>The finished README file<a class="headerlink" href="#the-finished-readme-fil
804806
</ul>
805807
</li>
806808
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#the-finished-readme-file">The finished README file</a></li>
809+
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#wrap-up"><i class="fa-solid fa-hands-bubbles"></i> Wrap up</a></li>
807810
</ul>
808811
</nav></div>
809812

0 commit comments

Comments
 (0)