README 2.9 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677
  1. ABOUT
  2. MuPDF is a lightweight PDF, XPS and CBZ viewer and parser/rendering library.
  3. The renderer in MuPDF is tailored for high quality anti-aliased graphics. It
  4. renders text with metrics and spacing accurate to within fractions of a pixel
  5. for the highest fidelity in reproducing the look of a printed page on screen.
  6. MuPDF is also small, fast, and yet complete. We support PDF 1.7 with
  7. transparency, encryption, hyperlinks, annotations, search and many other bells
  8. and whistles. MuPDF can also read XPS documents (OpenXPS / ECMA-388),
  9. and CBZ (Comic Book archive) files.
  10. MuPDF is written to be both modular and portable; the example applications
  11. are merely thin layers on top of the functionality offered by the library,
  12. so custom viewers can be easily built for a wide range of platforms. Example
  13. viewer applications are supplied for Windows, Linux, MacOS, iOS and Android.
  14. MuPDF is deliberately designed to be threading library agnostic, while still
  15. supporting multi-threaded operation. In the absence of a thread library
  16. it will run single-threaded, but by adding one significant benefits in
  17. rendering speed on multi-core platforms can be obtained.
  18. Interactive features such as form filling, javascript and transitions
  19. are in development and partially supported by the Android application.
  20. LICENSE
  21. MuPDF is Copyright 2006-2013 Artifex Software, Inc.
  22. This program is free software: you can redistribute it and/or modify it under
  23. the terms of the GNU Affero General Public License as published by the Free
  24. Software Foundation, either version 3 of the License, or (at your option) any
  25. later version.
  26. This program is distributed in the hope that it will be useful, but WITHOUT ANY
  27. WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
  28. PARTICULAR PURPOSE. See the GNU General Public License for more details.
  29. You should have received a copy of the GNU Affero General Public License along
  30. with this program. If not, see <http://www.gnu.org/licenses/>.
  31. For commercial licensing please contact sales@artifex.com.
  32. COMPILING
  33. If you are compiling from source you will need several third party libraries:
  34. freetype2, jbig2dec, libjpeg, openjpeg, and zlib. These libraries are contained
  35. in the source archive. If you are using git, they are included as git
  36. submodules.
  37. DOWNLOAD
  38. The latest development source is available directly from the git repository:
  39. git clone http://mupdf.com/repos/mupdf.git
  40. In the mupdf directory, update the third party libraries:
  41. git submodule update --init
  42. INSTALLING (UNIX)
  43. Typing "make prefix=/usr/local install" will install the binaries, man-pages,
  44. static libraries and header files on your system.
  45. REPORTING BUGS AND PROBLEMS
  46. The MuPDF developers hang out on IRC in the #ghostscript channel on
  47. irc.freenode.net.
  48. Report bugs on the ghostscript bugzilla, with MuPDF as the selected component.
  49. http://bugs.ghostscript.com/
  50. If you are reporting a problem with PDF parsing, please include the problematic
  51. file as an attachment.