Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
ASLeonard authored Oct 6, 2017
1 parent 0a9790d commit be7e736
Showing 1 changed file with 9 additions and 6 deletions.
15 changes: 9 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,19 @@
# *S*quare *L*attice Tile *A*ssembly *M*odel (SLAM)

Note this is currently dependent on
Note this is dependent on
> matplotlib

## Install

Not 100% sure yet, but download the release, extract, and then install
This should work
```bash
cd /path/to/download
tar xvzf SLAM-0.2.0.tar.gz
tar xvzf SLAM-0.2.0.tar.gz (or otherwise extract it)
cd /SLAM-0.2.0
python setup.py install --user
```
ignore the compile warnings for now
ignore the compiler warnings

---

Expand Down Expand Up @@ -40,8 +41,10 @@ Some nice examples to try

Can also pass additional arguments to GrowPoly

* write_it = False/True -> writes the animated gif to the local directory
* fps_par = float -> the number of steps per second in the written gif
* tile_labels = False/True -> labels the tile edges
* write_it = String-> writes the animated gif of this name to the local directory
* fps_par = float -> the number of frames per second in the written gif


---

Expand Down

0 comments on commit be7e736

Please sign in to comment.