Browse Source

Update README

Kevin Lee 1 month ago
parent
commit
fb16f06b97
1 changed files with 22 additions and 1 deletions
  1. 22 1
      README.md

+ 22 - 1
README.md

@@ -64,6 +64,7 @@ Usage: minilase.exe --input <INPUT> apply [OPTIONS] --config <CONFIG>
 Options:
   -c, --config <CONFIG>  Configuration file
   -o, --output <OUTPUT>  Output file to write to
+  -w, --overwrite        Overwrite output file if it exists
   -v, --verbose...       Increase logging verbosity
   -q, --quiet...         Decrease logging verbosity
   -h, --help             Print help
@@ -80,7 +81,7 @@ Setting values of specific fields for a given pen:
 ``` yaml
 Ops: 
   - !PatchPen
-    Pen: 0                  # Target pen
+    Pen: 0 # Target pen
 
     # Specify one or more of the following:
     Color: [127, 127, 127]
@@ -94,6 +95,26 @@ Ops:
 
 Where `<PulseWidth>` can be 2/4/6/8/12/20/30/45/60/80/100/150/200/250/350/500.
 
+Note: each pulse width has a minimum and maximum frequency:
+``` text
+2ns => 850kHz to 4MHz
+4ns => 500kHz to 4MHz
+6ns => 320kHz to 4MHz
+8ns => 250kHz to 4MHz
+12ns => 170kHz to 3MHz
+20ns => 115kHz to 3MHz
+30ns => 90kHz to 3MHz
+45ns => 75kHz to 2MHz
+60ns => 65kHz to 2MHz
+80ns => 60kHz to 2MHz
+100ns => 45kHz to 1MHz
+150ns => 30kHz to 1MHz
+200ns => 25kHz to 1MHz
+250ns => 25kHz to 900kHz
+350ns => 25kHz to 600kHz
+500ns => 25kHz to 500kHz
+```
+
 Cloning pen(s) (and optionally override settings):
 
 ``` yaml