Permalink
Browse files

Created README file for github; moved old readme to README.poppler.

  • Loading branch information...
1 parent cec4bba commit cbc2a9594caa4090972b4f0f42c89c4c7c75d78d Stuart Sierra committed Jun 23, 2008
Showing with 64 additions and 37 deletions.
  1. +27 −37 README
  2. +37 −0 README.poppler
View
64 README
@@ -1,37 +1,27 @@
-This is poppler, a PDF rendering library.
-
-Poppler is a fork of the xpdf PDF viewer developed by Derek Noonburg
-of Glyph and Cog, LLC. The purpose of forking xpdf is twofold.
-First, we want to provide PDF rendering functionality as a shared
-library, to centralize the maintenence effort. Today a number of
-applications incorporate the xpdf code base, and whenever a security
-issue is discovered, all these applications exchange patches and put
-out new releases. In turn, all distributions must package and release
-new version of these xpdf based viewers. It's safe to say that
-there's a lot of duplicated effort with the current situaion. Even if
-poppler in the short term introduces yet another xpdf derived code
-base to the world, we hope that over time these applications will
-adopt poppler. After all, we only need one application to use poppler
-to break even.
-
-Second, we would like to move libpoppler forward in a number of areas
-that doesn't fit within the goals of xpdf. By design, xpdf depends on
-very few libraries and runs a wide range of X based platforms. This
-is a strong feature and reasonable design goal. However, with poppler
-we would like to replace parts of xpdf that are now available as
-standard components of modern Unix desktop environments. One such
-example is fontconfig, which solves the problem of matching and
-locating fonts on the system, in a standardized and well understood
-way. Another example is cairo, which provides high quality 2D
-rendering. See the file TODO for a list of planned changes.
-
-Please note that xpdf, and thus poppler, is licensed under the GPL,
-not the LGPL. Consequently, any application using poppler must also
-be licensed under the GPL. If you want to incorporate Xpdf based PDF
-rendering in a closed source product, please contact Glyph & Cog
-(www.glyphandcog.com) for commercial licensing options.
-
- Kristian Høgsberg, Feb. 27, 2005
-
-
-See the README-XPDF for the original xpdf-3.00 README.
+This is a forked version of the Poppler PDF library,
+containing code specialized for parsing the PDF files
+released by Federal Appeals Court web sites.
+
+See README.poppler for the original Poppler readme.
+See INSTALL for compilation instructions.
+
+After compilation, there will be an executable named
+altlaw_parse_pdf in the utils/ directory.
+
+Run it like this:
+
+altlaw_parse_pdf input.pdf
+
+It prints an HTML representation of the PDF file to standard output.
+The HTML attempts to match the HTML used by the public.resource.org
+caselaw corpus. It does not include metadata tags.
+
+This software was developed by Dana Powers and Stuart Sierra.
+
+Like Poppler, this software is released under the GNU General Public
+License, version 2. See the file COPYING for details.
+
+Links:
+http://lawcommons.org/ -- open source legal research software
+http://altlaw.org/ -- free legal research database
+http://poppler.freedesktop.org/ -- the original code
View
@@ -0,0 +1,37 @@
+This is poppler, a PDF rendering library.
+
+Poppler is a fork of the xpdf PDF viewer developed by Derek Noonburg
+of Glyph and Cog, LLC. The purpose of forking xpdf is twofold.
+First, we want to provide PDF rendering functionality as a shared
+library, to centralize the maintenence effort. Today a number of
+applications incorporate the xpdf code base, and whenever a security
+issue is discovered, all these applications exchange patches and put
+out new releases. In turn, all distributions must package and release
+new version of these xpdf based viewers. It's safe to say that
+there's a lot of duplicated effort with the current situaion. Even if
+poppler in the short term introduces yet another xpdf derived code
+base to the world, we hope that over time these applications will
+adopt poppler. After all, we only need one application to use poppler
+to break even.
+
+Second, we would like to move libpoppler forward in a number of areas
+that doesn't fit within the goals of xpdf. By design, xpdf depends on
+very few libraries and runs a wide range of X based platforms. This
+is a strong feature and reasonable design goal. However, with poppler
+we would like to replace parts of xpdf that are now available as
+standard components of modern Unix desktop environments. One such
+example is fontconfig, which solves the problem of matching and
+locating fonts on the system, in a standardized and well understood
+way. Another example is cairo, which provides high quality 2D
+rendering. See the file TODO for a list of planned changes.
+
+Please note that xpdf, and thus poppler, is licensed under the GPL,
+not the LGPL. Consequently, any application using poppler must also
+be licensed under the GPL. If you want to incorporate Xpdf based PDF
+rendering in a closed source product, please contact Glyph & Cog
+(www.glyphandcog.com) for commercial licensing options.
+
+ Kristian Høgsberg, Feb. 27, 2005
+
+
+See the README-XPDF for the original xpdf-3.00 README.

0 comments on commit cbc2a95

Please sign in to comment.