From 2cc183b5dd118a26c719c64caa0bea23b36fcc1c Mon Sep 17 00:00:00 2001 From: "Unknown W. Brackets" Date: Sun, 26 Oct 2014 11:24:09 -0700 Subject: [PATCH] Update README. --- README.md | 44 ++++++++++++++++++++++++++++++++------------ cli/cli.cpp | 2 +- 2 files changed, 33 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 85e65a838..66be5dec3 100644 --- a/README.md +++ b/README.md @@ -18,9 +18,10 @@ Features =========== * Can use as many CPU cores as you want. - * Can use [zlib] (https://github.com/madler/zlib), [7-zip] (http://7-zip.org/)'s deflate, - and [Zopfli] (http://code.google.com/p/zopfli/). + * Can use [zlib][], [7-zip][]'s deflate, and [Zopfli][]. * Processes multiple files in one command. + * Can take a CSO or DAX file as a source. + * Able to output at larger block sizes. Compression @@ -36,6 +37,10 @@ that the increased disk access time is worth it. Using 7-zip's deflate and Zopfli improves compression ratios, but don't expect a lot. Usual results are between 0.5% to 1.0% smaller. +Larger block sizes than the default will help compression, in the range of 2-3%. However, the +files may not be compatible with some software. For example, [PPSSPP][] versions released +after 2014-10-26 will support larger block sizes. + Speed =========== @@ -57,14 +62,17 @@ Multiple files may be specified. Inputs can be iso or cso files. --threads=N Specify N threads for I/O and compression --quiet Suppress status output + --crc Log CRC32 checksums, ignore output files and methods --fast Use only basic zlib for fastest result - --use-METHOD Use a compression method: zlib, Zopfli, or 7zdeflate + --block=N Specify a block size (default is 2048) + Most readers only support the 2048 size + --use-METHOD Enable a compression method: zlib, Zopfli, or 7zdeflate By default, zlib and 7zdeflate are used - --no-METHOD Disable a compression method + --no-METHOD Disable a compression method, same as above ``` Because Zopfli is significantly slower than the other methods, and uses a lot more memory, it -is disabled by default. Use `--use-zopfli` for maximum compression. +is disabled by default. Add `--use-zopfli` for maximum compression. Platforms @@ -87,15 +95,27 @@ The larger portion of code here is from others' wonderful work in decompression libraries. Licensing is as follows: * maxcso is licensed under ISC. - * [7-zip] (http://7-zip.org/) is licensed under LGPL. - * [Zopfli] (http://code.google.com/p/zopfli/) is licensed under Apache 2.0. - * [libuv] (https://github.com/joyent/libuv) is licensed under MIT. - * [zlib] (https://github.com/madler/zlib) is licensed under zlib. + * [7-zip][] is licensed under LGPL. + * [Zopfli][] is licensed under Apache 2.0. + * [libuv][] is licensed under MIT. + * [zlib][] is licensed under zlib. Other tools =========== - * [CisoPlus] (http://cisoplus.pspgen.com/) - * [CisoMC] (http://wololo.net/talk/viewtopic.php?f=20&t=32659) - * [ciso] (http://sourceforge.net/projects/ciso/) + * [CisoPlus][] by kapoue3 + * [CisoMC][] by LMAN + * [ciso][] by BOOSTER + * [ciso-python][] by Virtuous Flame + + +[zlib]: https://github.com/madler/zlib +[7-zip]: http://7-zip.org/ +[Zopfli]: http://code.google.com/p/zopfli/ +[PPSSPP]: https://github.com/hrydgard/ppsspp +[libuv]: https://github.com/joyent/libuv +[CisoPlus]: http://cisoplus.pspgen.com/ +[CisoMC]: http://wololo.net/talk/viewtopic.php?f=20&t=32659 +[ciso]: http://sourceforge.net/projects/ciso/ +[ciso-python]: http://virtuousflame.blog.163.com/blog/static/177177172201111833413485/ \ No newline at end of file diff --git a/cli/cli.cpp b/cli/cli.cpp index d20364013..7151c72f5 100644 --- a/cli/cli.cpp +++ b/cli/cli.cpp @@ -24,7 +24,7 @@ void show_help(const char *arg0) { fprintf(stderr, " Most readers only support the 2048 size\n"); // TODO: Bring this back once it's functional. //fprintf(stderr, " --smallest Force compression of all sectors for smallest result\n"); - fprintf(stderr, " --use-METHOD Use a compression method: zlib, Zopfli, or 7zdeflate\n"); + fprintf(stderr, " --use-METHOD Enable a compression method: zlib, Zopfli, or 7zdeflate\n"); fprintf(stderr, " By default, zlib and 7zdeflate are used\n"); fprintf(stderr, " --no-METHOD Disable a compression method, same as above\n"); }