diff --git a/README.md b/README.md index ffcc5525e0fd13553cc5cb7de2abba245455ec99..560c145dd468a00bffe1ab1f83807e24457ab5e6 100644 --- a/README.md +++ b/README.md @@ -14,34 +14,31 @@ The main value of Crunch is reproducible image processing, as defined by a [pipe Basic CLI usage: ```shell -USAGE: - crunch [OPTIONS] <IN_PATH> <OUT_PATH> <SUBCOMMAND> - -ARGS: - <IN_PATH> The path to the spritesheet file - <OUT_PATH> The path to the output file - -OPTIONS: - -f, --format <FORMAT> Force Crunch to read the input file as a specific format [possible - values: png, jpg, gif, ico, tga, tiff, bmp] - -h, --help Print help information - -V, --version Print version information - -SUBCOMMANDS: - extrude Take each tile in an image and expand its borders by a given amount - flip Flip an image along one or both axis - help Print this message or the help of the given subcommand(s) - palette Create a palette file containing every distinct colour from the input image - pipeline Execute a pipeline file to run multiple commands on one or more images - remap Convert the colour space of an input image to the given palette - rotate Apply a clockwise rotation to the image - scale Make an image larger or smaller - +Command line asset manipulation, set up a pipeline once and run it against all of your files + +Usage: crunch <COMMAND> + +Commands: + rotate Rotate an image clockwise by the given degree + extrude Take each tile in an image and expand its borders by a given amount. Optionally fill with nearby pixels instead of empty space + palette Create a palette file containing every distinct colour from the input image + scale Resize an image by a scale factor + flip Flip an image along one or more axis + remap Convert the colour space of an image to that of a given palette file + pipeline Execute a predefined pipeline + reduce Limit the number of colours by quantity or threshold + split Take a spritesheet and split into individual sprites, skipping empty space + help Print this message or the help of the given subcommand(s) + +Options: + -h, --help Print help + -V, --version Print version ``` ## Downloads -- [Latest Release](https://lab.lcr.gr/microhacks/crunch/-/jobs/artifacts/trunk/raw/target/release/crunch?job=build-linux) +- [Latest Linux Version](https://lab.lcr.gr/microhacks/crunch/-/jobs/artifacts/trunk/raw/target/release/crunch?job=build-linux) +- [Latest Windows Version](https://lab.lcr.gr/microhacks/crunch/-/jobs/artifacts/trunk/raw/target/x86_64-pc-windows-gnu/crunch.exe?job=build-windows) ## Build From Source