New README, .gitignores; Makefile

Makefile: commented out unnecessary closure download and shell testing (at least until someone decides to work on this).

Makefile

@@ -55,30 +55,30 @@ browser-test:
 	--browserManifestFile=$(PDF_BROWSERS) \
 	--manifestFile=$(PDF_TESTS)
 
-# make shell-test
+# # make shell-test
-#
+# #
-# This target runs all of the tests that can be run in a JS shell.
+# # This target runs all of the tests that can be run in a JS shell.
-# The shell used is taken from the JS_SHELL environment variable. If
+# # The shell used is taken from the JS_SHELL environment variable. If
-# that variable is not defined, the script will attempt to use the copy
+# # that variable is not defined, the script will attempt to use the copy
-# of Rhino that comes with the Closure compiler used for producing the
+# # of Rhino that comes with the Closure compiler used for producing the
-# website.
+# # website.
-SHELL_TARGET = $(NULL)
+# SHELL_TARGET = $(NULL)
-ifeq ($(JS_SHELL),)
+# ifeq ($(JS_SHELL),)
-JS_SHELL := "java -cp $(BUILD_DIR)/compiler.jar"
+# JS_SHELL := "java -cp $(BUILD_DIR)/compiler.jar"
-JS_SHELL += "com.google.javascript.jscomp.mozilla.rhino.tools.shell.Main"
+# JS_SHELL += "com.google.javascript.jscomp.mozilla.rhino.tools.shell.Main"
-SHELL_TARGET = compiler
+# SHELL_TARGET = compiler
-endif
+# endif
-
+# 
-shell-test: shell-msg $(SHELL_TARGET) font-test
+# shell-test: shell-msg $(SHELL_TARGET) font-test
-shell-msg:
+# shell-msg:
-ifeq ($(SHELL_TARGET), compiler)
+# ifeq ($(SHELL_TARGET), compiler)
-	@echo "No JS_SHELL env variable present."
+#   @echo "No JS_SHELL env variable present."
-	@echo "The default is to find a copy of Rhino and try that."
+#   @echo "The default is to find a copy of Rhino and try that."
-endif
+# endif
-	@echo "JS shell command is: $(JS_SHELL)"
+#   @echo "JS shell command is: $(JS_SHELL)"
-
+# 
-font-test:
+# font-test:
-	@echo "font test stub."
+#   @echo "font test stub."
 
 # make lint
 #
@@ -133,18 +133,18 @@ $(GH_PAGES)/web/%: web/%
 $(GH_PAGES)/web/images/%: web/images/%
 	@cp $< $@
 
-# make compiler
+# # make compiler
-#
+# #
-# This target downloads the Closure compiler, and places it in the
+# # This target downloads the Closure compiler, and places it in the
-# build directory. This target is also useful when the user doesn't
+# # build directory. This target is also useful when the user doesn't
-# have a JS shell available--we can have them use the Rhino shell that
+# # have a JS shell available--we can have them use the Rhino shell that
-# comes with Closure.
+# # comes with Closure.
-COMPILER_URL = http://closure-compiler.googlecode.com/files/compiler-latest.zip
+# COMPILER_URL = http://closure-compiler.googlecode.com/files/compiler-latest.zip
-
+# 
-compiler: $(BUILD_DIR)/compiler.zip
+# compiler: $(BUILD_DIR)/compiler.zip
-$(BUILD_DIR)/compiler.zip: | $(BUILD_DIR)
+# $(BUILD_DIR)/compiler.zip: | $(BUILD_DIR)
-	curl $(COMPILER_URL) > $(BUILD_DIR)/compiler.zip;
+#   curl $(COMPILER_URL) > $(BUILD_DIR)/compiler.zip;
-	cd $(BUILD_DIR); unzip compiler.zip compiler.jar;
+#   cd $(BUILD_DIR); unzip compiler.zip compiler.jar;
 
 # make firefox-extension
 #

README.md

@@ -1,17 +1,80 @@
 # pdf.js
 
-pdf.js is a technology demonstrator prototype to explore whether the HTML5
-platform is complete enough to faithfully and efficiently render the ISO
-32000-1:2008 Portable Document Format (PDF) without native code assistance.
 
-pdf.js is not currently part of the Mozilla project, and there is no plan
+
-yet to integrate it into Firefox. We will explore that possibility once
+## Overview
-pdf.js is production ready. Until then we aim to publish a Firefox
+
-PDF reader extension powered by pdf.js.
+pdf.js is an HTML5 technology experiment that explores building a faithful
+and efficient Portable Document Format (PDF) renderer without native code 
+assistance.
+
+pdf.js is community-driven and supported by Mozilla Labs. Our goal is to 
+create a general-purpose, web standards-based platform for parsing and 
+rendering PDFs, and eventually release a PDF reader extension powered by 
+pdf.js. Integration with Firefox is a possibility if the experiment proves 
+successful.
+
+
+
+## Getting started
+
+For an online demo, visit:
+
+  http://andreasgal.github.com/pdf.js/web/viewer.html
+
+This demo provides an interactive interface for displaying and browsing PDFs
+using the pdf.js API.
+
+For a "hello world" example, take a look at:
+
+    examples/helloworld/
+
+This example illustrates the bare minimum ingredients for integrating pdf.js
+in a custom project.
+
+
+
+## Running the Tests
+
+pdf.js comes with browser-level regression tests that allow one to probe 
+whether it's able to successfully parse PDFs, as well as compare its output
+against reference images, pixel-by-pixel.
+
+To run the tests, first configure the browser manifest file at:
+
+    test/resources/browser_manifests/browser_manifest.json
+
+Sample manifests for different platforms are provided in that directory.
+
+To run all the bundled tests, type:
+
+    $ make test
+
+and cross your fingers. Different types of tests are available, see the test
+manifest file at:
+
+    test/test_manifest.json
+
+The test type `eq` tests whether the output images are identical to reference 
+images. The test type `load` simply tests whether the file loads without 
+raising any errors.
+
+
+## Contributing
+
+pdf.js is a community-driver project, so contributors are always welcome. 
+Simply fork our repo and contribute away. A great place to start is our
+open issues. 
+
+For better consistency and long-term stability, please do look around the 
+code and try to follow our conventions.
+
+
+## Additional resources
 
 Our demo site is here:
 
-  http://andreasgal.github.com/pdf.js/
+  http://andreasgal.github.com/pdf.js/web/viewer.html
 
 You can read more about pdf.js here:
 
@@ -19,14 +82,14 @@ You can read more about pdf.js here:
 
   http://blog.mozilla.com/cjones/2011/06/15/overview-of-pdf-js-guts/
 
-follow us on twitter: @pdfjs
+Follow us on twitter: @pdfjs
 
   http://twitter.com/#!/pdfjs
 
-join our mailing list:
+Join our mailing list:
 
   dev-pdf-js@lists.mozilla.org
 
-and talk to us on IRC:
+Talk to us on IRC:
 
   #pdfjs on irc.mozilla.org

test/pdfs/.gitignore

@@ -1,3 +1,13 @@
-pdf.pdf
+DiwanProfile.pdf
+artofwar.pdf
+cable.pdf
+ecma262.pdf
+hmm.pdf
+i9.pdf
 intelisa.pdf
 openweb_tm-PRINT.pdf
+pdf.pdf
+pdkids.pdf
+shavian.pdf
+jai.pdf
+

test/resources/browser_manifests/.gitignore

@@ -0,0 +1,2 @@
+browser_manifest.json
+