Skip to content

Commit

Permalink
fix some typos & update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
m0saan committed Jun 2, 2023
1 parent a8bade1 commit bdfd424
Show file tree
Hide file tree
Showing 12 changed files with 352 additions and 372 deletions.
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,8 +40,10 @@ To install with pip, use: `pip install minima`.
If you plan to develop Minima yourself, or want to be on the cutting
edge, you can use an editable install.

git clone https://github.com/yourusername/minima
pip install -e "minima[dev]"
``` bash
git clone https://github.com/m0saan/minima
pip install .
```

## Features

Expand Down
94 changes: 54 additions & 40 deletions _docs/autograd.html

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions _docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -234,8 +234,8 @@ <h2 class="anchored" data-anchor-id="installing">Installing</h2>
<div class="sourceCode" id="cb2"><pre class="sourceCode bash code-with-copy"><code class="sourceCode bash"><span id="cb2-1"><a href="#cb2-1" aria-hidden="true" tabindex="-1"></a><span class="ex">conda</span> install minima anaconda</span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
<p>To install with pip, use: <code>pip install minima</code>.</p>
<p>If you plan to develop Minima yourself, or want to be on the cutting edge, you can use an editable install.</p>
<pre><code>git clone https://github.com/yourusername/minima
pip install -e "minima[dev]"</code></pre>
<div class="sourceCode" id="cb3"><pre class="sourceCode bash code-with-copy"><code class="sourceCode bash"><span id="cb3-1"><a href="#cb3-1" aria-hidden="true" tabindex="-1"></a><span class="fu">git</span> clone https://github.com/m0saan/minima</span>
<span id="cb3-2"><a href="#cb3-2" aria-hidden="true" tabindex="-1"></a><span class="ex">pip</span> install .</span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
</section>
<section id="features" class="level2">
<h2 class="anchored" data-anchor-id="features">Features</h2>
Expand Down
4 changes: 2 additions & 2 deletions _docs/search.json

Large diffs are not rendered by default.

10 changes: 5 additions & 5 deletions _docs/sitemap.xml
Original file line number Diff line number Diff line change
Expand Up @@ -2,22 +2,22 @@
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
<url>
<loc>https://m0saan.github.io/minima/core.html</loc>
<lastmod>2023-06-02T03:36:26.516Z</lastmod>
<lastmod>2023-06-02T03:40:00.224Z</lastmod>
</url>
<url>
<loc>https://m0saan.github.io/minima/Untitled.html</loc>
<lastmod>2023-06-02T03:36:28.366Z</lastmod>
<lastmod>2023-06-02T03:40:01.908Z</lastmod>
</url>
<url>
<loc>https://m0saan.github.io/minima/operators.html</loc>
<lastmod>2023-06-02T03:36:29.120Z</lastmod>
<lastmod>2023-06-02T03:40:02.920Z</lastmod>
</url>
<url>
<loc>https://m0saan.github.io/minima/autograd.html</loc>
<lastmod>2023-06-02T03:36:30.158Z</lastmod>
<lastmod>2023-06-02T03:40:04.076Z</lastmod>
</url>
<url>
<loc>https://m0saan.github.io/minima/index.html</loc>
<lastmod>2023-06-02T03:36:31.448Z</lastmod>
<lastmod>2023-06-02T03:40:04.645Z</lastmod>
</url>
</urlset>
Loading

0 comments on commit bdfd424

Please sign in to comment.