aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md40
1 files changed, 40 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..55e0fa9
--- /dev/null
+++ b/README.md
@@ -0,0 +1,40 @@
+Melon
+=====
+
+Melon: Converter that produces PDF from CNKI proprietary formats
+
+Development
+-----------
+
+Currently, PDF, CAJ, and KDH can be converted. Please report
+any failures with a sample that can reproduce the behaviour.
+
+KDH is essentially an invalid PDF file xor'ed with a predetermined key.
+You may want to convert the decrypted KDH to valid PDF, although some
+PDF readers can display the invalid PDF.
+
+Usage
+=====
+
+`make`
+
+Optionally, `make install`
+
+`melon -o OUTPUT INPUT`
+
+Options
+-------
+
+-o, --output
+Specify output file
+
+-b, --buffer
+Set buffer size (default 512k)
+
+-v, --verbose
+Print more information (twice for even more)
+
+Thanks
+======
+
+This project is inspired by [https://github.com/JeziL/caj2pdf](https://github.com/JeziL/caj2pdf)