README.md

danieledapo · Feb 1, 2023 · 305f41a · 305f41a
1 parent f117385
commit 305f41a
Show file tree

Hide file tree

Showing 4 changed files with 11 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -1,3 +1,13 @@
 # Termesh
 
-Display simple stl in your terminal!
+Explore 3D meshes in your terminal!
+
+![teapot1](images/teapot1.png)![teapot2](images/teapot2.png)![teapot3](images/teapot3.png)
+
+## Usage
+
+```shell
+$ cargo run --release -- --help
+$ cargo run --release -- data/teapot.stl
+$ cargo run --release -- data/teapot.stl --wireframe --non-interactive --rotation-x 0.8 --scale 40 --no-depth
+```
diff --git a/images/teapot1.png b/images/teapot1.png
diff --git a/images/teapot2.png b/images/teapot2.png
diff --git a/images/teapot3.png b/images/teapot3.png