Skip to content

Commit

Permalink
Add proper install instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
phinate committed Mar 5, 2020
1 parent 3dbf3f2 commit bf893b2
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 1 deletion.
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,12 @@
![](training.gif)

## Install
To use `neos` right now, you have to seperately install the `fax` library for fixed-point differentiation:

`pip install git+https://github.com/gehring/fax.git`

Then just run

`pip install neos`

## How to use (and reproduce the results from the cool animation)
Expand Down
5 changes: 4 additions & 1 deletion docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,10 @@
</div>
<div class="cell border-box-sizing text_cell rendered"><div class="inner_cell">
<div class="text_cell_render border-box-sizing rendered_html">
<h2 id="Install">Install<a class="anchor-link" href="#Install">&#182;</a></h2><p><code>pip install neos</code></p>
<h2 id="Install">Install<a class="anchor-link" href="#Install">&#182;</a></h2><p>To use <code>neos</code> right now, you have to seperately install the <code>fax</code> library for fixed-point differentiation:</p>
<p><code>pip install git+https://github.com/gehring/fax.git</code></p>
<p>Then just run</p>
<p><code>pip install neos</code></p>

</div>
</div>
Expand Down

0 comments on commit bf893b2

Please sign in to comment.