CLI in readme

virtual-vehicle · Feb 22, 2022 · c3f0896 · c3f0896
1 parent 16dd9dd
commit c3f0896
Show file tree

Hide file tree

Showing 2 changed files with 29 additions and 1 deletion.
diff --git a/README.rst b/README.rst
@@ -127,6 +127,32 @@ This produces the plot from the animation above.
 .. _html documentation: https://virtual-vehicle.github.io/pointcloudset/
 .. _tutorial notebooks: https://github.com/virtual-vehicle/pointcloudset/tree/master/doc/sphinx/source/tutorial_notebooks
 
+
+CLI to convert ROS bag files to pointcloudset or csv, las and more
+################################################
+
+.. raw:: html
+
+    <embed>
+        <html>
+      <head>
+      <link rel="stylesheet" type="text/css" href="asciinema-player.css" />
+      </head>
+      <body>
+      <div id="player"></div>
+      <script src="asciinema-player.min.js"></script>
+      <script>
+         AsciinemaPlayer.create(
+            '470722.cast',
+            document.getElementById('player'),
+            { cols: 131, rows: 20 }
+         );
+      </script>
+      </body>
+      </html>
+    </embed>
+
+
 Comparison to related packages
 ################################################
 

diff --git a/doc/sphinx/source/commandline_interface.rst b/doc/sphinx/source/commandline_interface.rst
@@ -31,4 +31,6 @@ the converted directory.
 
 .. click:: pointcloudset.io.dataset.commandline:typer_click_object
    :prog: rosbagconvert
-   :nested: full
+   :nested: full
+
+    rosbagconvert . -d converted -o csv