Skip to content

Commit

Permalink
deploy: da477d2
Browse files Browse the repository at this point in the history
  • Loading branch information
lwasser committed Mar 5, 2024
1 parent 698c37c commit d47df6e
Show file tree
Hide file tree
Showing 5 changed files with 23 additions and 17 deletions.
Binary file modified .doctrees/environment.pickle
Binary file not shown.
Binary file modified .doctrees/tutorials/add-readme.doctree
Binary file not shown.
5 changes: 4 additions & 1 deletion _sources/tutorials/add-readme.md.txt
Original file line number Diff line number Diff line change
Expand Up @@ -221,11 +221,14 @@ You can also add any links to tutorials in your documentation here.

## Community

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.
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.

## How to cite pyosPackage

citation information here
````

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

Expand Down
2 changes: 1 addition & 1 deletion searchindex.js

Large diffs are not rendered by default.

33 changes: 18 additions & 15 deletions tutorials/add-readme.html
Original file line number Diff line number Diff line change
Expand Up @@ -721,28 +721,30 @@ <h2>The finished README file<a class="headerlink" href="#the-finished-readme-fil

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

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.
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.

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

citation information here

<span class="gu">## &lt;i class=&quot;fa-solid fa-hands-bubbles&quot;&gt;&lt;/i&gt; Wrap up</span>

It&#39;s important to consider the information that a new user or contributor might
need when creating your <span class="sb">`README.md`</span> file. While there is no perfect template,
</pre></div>
</div>
</section>
<section id="wrap-up">
<h2><i class="fa-solid fa-hands-bubbles"></i> Wrap up<a class="headerlink" href="#wrap-up" title="Link to this heading">#</a></h2>
<p>It’s important to consider the information that a new user or contributor might
need when creating your <code class="docutils literal notranslate"><span class="pre">README.md</span></code> file. While there is no perfect template,
above is a set of recommendations as you are just getting started. You may find
the need for other elements to be added to this file as you further develop your
package and as a community begins to use your package.

In the [<span class="nt">next lesson</span>](<span class="na">add-license-coc.md</span>), you will add a LICENSE file to
package and as a community begins to use your package.</p>
<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
your Python package. A license file is critical as it tells users
how they legally can (and can&#39;t) use your package. It also:

<span class="k">*</span><span class="w"> </span>Builds trust with your users
<span class="k">*</span><span class="w"> </span>Discourages misuse of your package and associated code
</pre></div>
</div>
how they legally can (and can’t) use your package. It also:</p>
<ul class="simple">
<li><p>Builds trust with your users</p></li>
<li><p>Discourages misuse of your package and associated code</p></li>
</ul>
</section>
</section>

Expand Down Expand Up @@ -804,6 +806,7 @@ <h2>The finished README file<a class="headerlink" href="#the-finished-readme-fil
</ul>
</li>
<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>
<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>
</ul>
</nav></div>

Expand Down

0 comments on commit d47df6e

Please sign in to comment.