Skip to content

Commit be7e736

Browse files
authored
Update README.md
1 parent 0a9790d commit be7e736

File tree

1 file changed

+9
-6
lines changed

1 file changed

+9
-6
lines changed

README.md

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,19 @@
11
# *S*quare *L*attice Tile *A*ssembly *M*odel (SLAM)
22

3-
Note this is currently dependent on
3+
Note this is dependent on
4+
> matplotlib
45
56

67
## Install
78

8-
Not 100% sure yet, but download the release, extract, and then install
9+
This should work
910
```bash
1011
cd /path/to/download
11-
tar xvzf SLAM-0.2.0.tar.gz
12+
tar xvzf SLAM-0.2.0.tar.gz (or otherwise extract it)
1213
cd /SLAM-0.2.0
1314
python setup.py install --user
1415
```
15-
ignore the compile warnings for now
16+
ignore the compiler warnings
1617

1718
---
1819

@@ -40,8 +41,10 @@ Some nice examples to try
4041

4142
Can also pass additional arguments to GrowPoly
4243

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

4649
---
4750

0 commit comments

Comments
 (0)