Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Maxattax97 committed Mar 15, 2019
1 parent 8b6f54b commit 5b30d86
Showing 1 changed file with 22 additions and 13 deletions.
35 changes: 22 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,21 +19,30 @@ $ openscad-format --help
Usage: openscad-format [options]
Options:
--version Show version number [boolean]
-i, --input Input file to read, file globs allowed (quotes recommended)
-o, --output Output file to write
-h, --help Show help [boolean]
--version Show version number [boolean]
-i, --input Input file to read, file globs allowed (quotes recommended)
[string]
-o, --output Output file to write [string]
-c, --config Use the specified path to a config using the .clang-format
style file [string]
-j, --javadoc Automatically add {Java,JS}doc-style comment templates to
functions and modules where missing [boolean]
-f, --force Forcibly overwrite (or "fix") the source file [boolean]
-d, --dry Perform a dry run, without writing [boolean]
-h, --help Show help [boolean]
Examples:
openscad-format -i input.scad -o output.scad Formats input.scad and saves it as
output.scad
openscad-format < input.scad > output.scad Formats input.scad and saves it as
output.scad
openscad-format < input.scad Formats input.scad and writes to stdout
cat input.scad | openscad-format | less Formats input.scad and displays in less
openscad-format -i './**/*.scad' Formats all *.scad files recursively
and writes them to their respective
files
openscad-format -i input.scad -o Formats input.scad and saves it as
output.scad output.scad
openscad-format < input.scad > Formats input.scad and saves it as
output.scad output.scad
openscad-format < input.scad Formats input.scad and writes to
stdout
cat input.scad | openscad-format | less Formats input.scad and displays in
less
openscad-format -i './**/*.scad' Formats all *.scad files recursively
and writes them to their respective
files
This utility requires clang-format, but this is automatically installed for most
platforms.
Expand Down

0 comments on commit 5b30d86

Please sign in to comment.