README: description

This commit is contained in:
Fabien LOISON 2018-01-15 16:55:57 +01:00
parent 77619be3ac
commit d0034c64a8
No known key found for this signature in database
GPG Key ID: FF90CA148348048E
1 changed files with 22 additions and 1 deletions

View File

@ -1,4 +1,25 @@
YOGA - Yummy Optimizer for Gorgeous Assets
==========================================
TODO
YOGA is a command-line tool and a library that can:
* convert and optimize images from various format to JPEG and PNG,
* *convert and optimize 3D models from various formats to gLTF and GLB.* **NOT YET IMPLEMENTED**
Images are opened using Pillow and optimized using Guetzli (for JPEGs) and
Zopflipng (for PNGs).
3D Models are converted and optimized using ASSIMP. If models contain or
reference images, they are processed by YOGA's image optimizer.
Convert and optimize an image from CLI::
yoga image --output-format=jpeg --jpeg-quality=84 input.png output.jpg
yoga image --output-format=png input.png output.png
yoga image --help
Convert and optimize a 3D model from CLI::
# TODO (not implemented yet)
yoga model --help