From: Jamie Macey <jamie@tracefunc.com>
Date: Sat, 27 Nov 2010 05:00:03 +0000 (-0800)
Subject: add a README
X-Git-Tag: v1.0.0
X-Git-Url: https://chaos.moe/g/?a=commitdiff_plain;h=3a0930b39d287fe181d8d58a2269bfb927ca0d6e;p=console%2Fciso.git

add a README
---

diff --git a/README.markdown b/README.markdown
new file mode 100644
index 0000000..1242b2c
--- /dev/null
+++ b/README.markdown
@@ -0,0 +1,28 @@
+ciso is a simple commandline utility to compress PSP iso files.
+
+This package is a (currently incomplete) port of a package provided
+by Ubuntu: http://packages.ubuntu.com/natty/ciso
+
+# Usage
+
+To decompress a cso file:
+
+  ciso 0 infile.cso outfile.iso
+
+To compress an iso file:
+
+  ciso level infile.iso outfile.cso
+
+where level ranges from 1 (fast, poor compression) to 9 (slow, high
+compression).
+
+# WARNING
+
+Do Not Trust Your Data To This
+
+While it appears that iso -> cso -> iso roundtrips are lossless, the
+generated cso is broken and existing csos that I have are not
+recognized by the executable.
+
+Given the compilation warnings I get I am assuming it's buggy due to
+differences between Linux and MacOS libraries.