Skip to content

Commit bf893b2

Browse files
committed
Add proper install instructions
1 parent 3dbf3f2 commit bf893b2

File tree

2 files changed

+10
-1
lines changed

2 files changed

+10
-1
lines changed

README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,12 @@
77
![](training.gif)
88

99
## Install
10+
To use `neos` right now, you have to seperately install the `fax` library for fixed-point differentiation:
11+
12+
`pip install git+https://github.com/gehring/fax.git`
13+
14+
Then just run
15+
1016
`pip install neos`
1117

1218
## How to use (and reproduce the results from the cool animation)

docs/index.html

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,10 @@
3838
</div>
3939
<div class="cell border-box-sizing text_cell rendered"><div class="inner_cell">
4040
<div class="text_cell_render border-box-sizing rendered_html">
41-
<h2 id="Install">Install<a class="anchor-link" href="#Install">&#182;</a></h2><p><code>pip install neos</code></p>
41+
<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>
42+
<p><code>pip install git+https://github.com/gehring/fax.git</code></p>
43+
<p>Then just run</p>
44+
<p><code>pip install neos</code></p>
4245

4346
</div>
4447
</div>

0 commit comments

Comments
 (0)