diff --git a/slicer/README.md b/slicer/README.md index 6452beb..6f3a244 100644 --- a/slicer/README.md +++ b/slicer/README.md @@ -1,7 +1,19 @@ # `slicer` This crate contains the types and algorithms to efficiently slice a mesh and some other stuff for post processing and support generation. -It also exposes a CLI for slicing models, open the dropdown below to see it's help page. + +## Command Line interface + +This crate also exposes a CLI for slicing models, open the dropdown below to view the help page. + +Multiple meshes can be added by using the `--mesh` argument more than once. +If you want to change any properties of the mesh like position, rotation, or scale, you can use the flag followed by a 3D vector (`x,y,z`). +These flags will modify the mesh defined most recently. +See the example below. + +```bash +$ slicer --mesh teapot.stl --position 0,0,-0.05 --scale 2,2,2 --mesh frog.stl --position 100,0,0 output.goo +```
CLI Help @@ -41,6 +53,8 @@ Options: The speed to lift the platform after exposing each first layer, in mm/min [default: 65] --first-retract-speed The speed to retract (move down) the platform after exposing each first layer, in mm/min [default: 150] + --preview + Path to a preview image, will be scaled as needed --mesh Path to a .stl or .obj file --position