Merge pull request #48 from AngelFP/doc-cli-tools

Doc: CLI Tools
AngelFP · Apr 20, 2023 · 9ea6b14 · 9ea6b14
2 parents 381389a + 4d36820
commit 9ea6b14
Showing 1 changed file with 6 additions and 1 deletion.
diff --git a/examples/README.md b/examples/README.md
@@ -10,4 +10,9 @@ This folder contains examples covering the basic use of the code:
 
 <p align="center">
   <img alt="Basic render window" src="example_2/image_5.png" width="400px" />
-</p>
+</p>
+
+* Example 3: Use the command line tools
+
+  * `vpic3d -h`: 3D scenes (VTK)
+  * `vpic -h`: 2D scenes (matplotlib)