update readme

RansML · RansML · commit b0f1d17a1e7c · 2016-06-06T09:47:55.000+10:00
diff --git a/README.md b/README.md
@@ -1 +1,17 @@
-# simulator_lidar
+# simulator_lidar
+
+This is a simple LIDAR simulator developed in python3. A world with moving vehicles can be set up by instantiating "Obstacle" class. 
+
+Requires:
+ - python3
+ - numpy library
+ - matplotlib library (for images and videos)
+ - moviepy library (for videos) 
+
+Define:
+ - obstacles (position, velocity and acceleration)
+
+Output:
+ - carmen.log.gfs, time_x_y.csv, frame_i.png, movie.gif/mp4
+
+
diff --git a/README.md~ b/README.md~
@@ -0,0 +1,5 @@
+# simulator_lidar
+
+This is a LIDAR simulator. A simple world with moving vehicles can be set up by instantiating "Obstacle" class. 
+
+

-Original file line number
+Diff line change
@@ @@ -0,0 +1,5 @@ @@
 +# simulator_lidar
++
 +This is a LIDAR simulator. A simple world with moving vehicles can be set up by instantiating "Obstacle" class.
++
++