From 7f2aca7f6efa4677f419712c3ff81033f0eb1c08 Mon Sep 17 00:00:00 2001 From: Robin Watts Date: Tue, 20 Mar 2012 14:34:29 +0000 Subject: Updated README file for 1.0 release. --- README | 27 ++++++++++++++++++++------- 1 file changed, 20 insertions(+), 7 deletions(-) (limited to 'README') diff --git a/README b/README index fb0b3852..34bc7789 100644 --- a/README +++ b/README @@ -1,6 +1,6 @@ ABOUT -MuPDF is a lightweight PDF and XPS viewer and parser/rendering library. +MuPDF is a lightweight PDF, XPS and CBZ viewer and parser/rendering library. The renderer in MuPDF is tailored for high quality anti-aliased graphics. It renders text with metrics and spacing accurate to within fractions of a pixel @@ -8,11 +8,22 @@ for the highest fidelity in reproducing the look of a printed page on screen. MuPDF is also small, fast, and yet complete. We support PDF 1.7 with transparency, encryption, hyperlinks, annotations, search and many other bells -and whistles. MuPDF can also read XPS documents (OpenXPS / ECMA-388). +and whistles. MuPDF can also read XPS documents (OpenXPS / ECMA-388), +and CBZ (Comic Book archive) files. + +MuPDF is written to be both modular and portable; the example applications +are merely thin layers on top of the functionality offered by the library, +so custom viewers can be easily built for a wide range of platforms. Example +viewer applications are supplied for Windows, Linux, MacOS, iOS and Android. + +MuPDF is deliberately designed to be threading library agnostic, while still +supporting multi-threaded operation. In the absence of a thread library +it will run single-threaded, but by adding one significant benefits in +rendering speed on multi-core platforms can be obtained. We don't support interactive features such as form filling, javascript and -transitions. MuPDF is written modularly, so such features can be added on by -integrators if they so desire. +transitions, but such features can be added on by integrators if they so +desire. LICENSE @@ -39,7 +50,8 @@ freetype2, jbig2dec, libjpeg, openjpeg, and zlib. We have prepared a package (mupdf-thirdparty.zip) that you can unzip in the mupdf source tree if you don't have them installed on your system. -You must unpack mupdf-thirdparty.zip to build using the Visual Studio project. +You must unpack mupdf-thirdparty.zip to build using the Visual Studio or Xcode +projects, or the example android makefiles. DOWNLOAD @@ -47,14 +59,15 @@ The latest development source is available directly from the git repository: git clone http://mupdf.com/repos/mupdf.git -INSTALLING +INSTALLING (UNIX) Typing "make prefix=/usr/local install" will install the binaries, man-pages, static libraries and header files on your system. REPORTING BUGS AND PROBLEMS -The MuPDF developers hang out on IRC in the #ghostscript channel on irc.freenode.net. +The MuPDF developers hang out on IRC in the #ghostscript channel on +irc.freenode.net. Report bugs on the ghostscript bugzilla, with MuPDF as the selected component. -- cgit v1.2.3