diff --git a/README.md b/README.md index fd683c9..0c8d438 100644 --- a/README.md +++ b/README.md @@ -59,11 +59,15 @@ The BreezySLAM installation uses the popular approach to installing Python packages, so all you should have to do is download and unzip the file, cd to BreezySLAM-master/python, and do -
+sudo python setup.py install +For a quick demo, you can then cd to BreezySLAM-master/examples and do -
+make pytest +This will generate and display a PGM file showing the @@ -76,7 +80,9 @@ a PNG file instead. If you have installed OpenCV for Python, you can see a “live” animation by doing -
+make cvmovie +You can turn off odometry by setting the USE_ODOMETRY parameter at the top of the Makefile to 0 (zero). You can turn off @@ -87,7 +93,9 @@ the particle-filter (Monte Carlo position estimation) by commenting-out To see what other features are available, do -
+pydoc breezyslam +By using the component classes Map, Scan, and Position and the distanceScanToMap() method, @@ -141,7 +149,9 @@ variable at the top of the Makefile. For a quick demo, you can then cd to BreezySLAM-master/examples and do -
+make cpptest +
@@ -162,8 +172,9 @@ Then run make in these directories, and also in For a quick demo, you can then cd to BreezySLAM-master/examples and do -
+make javatest +