Add readme to slicer crate

slicer/README.md

@@ -0,0 +1,55 @@
+# `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.
+
+<details>
+  <summary>CLI Help</summary>
+
+```plain
+mslicer command line interface
+
+Usage: slicer [OPTIONS] <MESH|--position <POSITION>|--rotation <ROTATION>|--scale <SCALE>> <OUTPUT>
+
+Arguments:
+  <MESH>    Path to a .stl or .obj file
+  <OUTPUT>  File to save sliced result to. Currently only .goo files can be generated
+
+Options:
+      --platform-resolution <PLATFORM_RESOLUTION>
+          Resolution of the printer mask display in pixels [default: "11520, 5120"]
+      --platform-size <PLATFORM_SIZE>
+          Size of the printer display / platform in mm [default: "218.88, 122.904, 260.0"]
+      --layer-height <LAYER_HEIGHT>
+          Layer height in mm [default: 0.05]
+      --first-layers <FIRST_LAYERS>
+          Number of 'first layers'. These are layers that obey the --first- exposure config flags [default: 3]
+      --transition-layers <TRANSITION_LAYERS>
+          Number of transition layers. These are layers that interpolate from the first layer config to the default config [default: 10]
+      --exposure-time <EXPOSURE_TIME>
+          Layer exposure time in seconds [default: 3]
+      --lift-distance <LIFT_DISTANCE>
+          Distance to lift the platform after exposing each regular layer, in mm [default: 5]
+      --lift-speed <LIFT_SPEED>
+          The speed to lift the platform after exposing each regular layer, in mm/min [default: 65]
+      --retract-speed <RETRACT_SPEED>
+          The speed to retract (move down) the platform after exposing each regular layer, in mm/min [default: 150]
+      --first-exposure-time <FIRST_EXPOSURE_TIME>
+          First layer exposure time in seconds [default: 30]
+      --first-lift-distance <FIRST_LIFT_DISTANCE>
+          Distance to lift the platform after exposing each first layer, in mm [default: 5]
+      --first-lift-speed <FIRST_LIFT_SPEED>
+          The speed to lift the platform after exposing each first layer, in mm/min [default: 65]
+      --first-retract-speed <FIRST_RETRACT_SPEED>
+          The speed to retract (move down) the platform after exposing each first layer, in mm/min [default: 150]
+      --position <POSITION>
+          Location of the bottom center of model bounding box. The origin is the center of the build plate [default: "0, 0, 0"]
+      --rotation <ROTATION>
+          Rotation of the model in degrees, pitch, roll, yaw [default: "0, 0, 0"]
+      --scale <SCALE>
+          Scale of the model along the X, Y, and Z axes [default: "1, 1, 1"]
+  -h, --help
+          Print help
+```
+
+</details>