Sakurai/pdf.js
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

README formatting

Browse Source
This commit is contained in:
Artur Adib 2011-09-29 14:44:41 -04:00
parent 0ca97fd22b
commit e14dbd5fc0
1 changed files with 33 additions and 34 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

67
README.md
View File

@ -18,16 +18,16 @@ successful.
## Getting started
**Online demo**
### Online demo
For an online demo, visit:
http://andreasgal.github.com/pdf.js/web/viewer.html
+ 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.
**Getting the code**
### Getting the code
To get a local copy of the current code, clone it using git:
@ -45,19 +45,19 @@ PDF files for a file:// url:
If everything worked out, you can now serve
http://localhost:8888/web/viewer.html
+ http://localhost:8888/web/viewer.html
You can also view all the test pdf files on the right side serving
http://localhost:8888/test/pdfs/?frame
+ http://localhost:8888/test/pdfs/?frame
**Hello world**
### Hello world
For a "hello world" example, take a look at:
examples/helloworld/
+ [examples/helloworld/hello.js](blob/master/examples/helloworld/hello.js)
This example illustrates the bare minimum ingredients for integrating pdf.js
in a custom project.
@ -71,8 +71,8 @@ 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.
If you __don't want to hack__ on the project or have short spare times, you still
can help! Just open PDFs in the
If you don't want to hack on the project or have short spare times, __you still
can help!__ Just open PDFs in the
[online demo](http://andreasgal.github.com/pdf.js/web/viewer.html) and report
any breakage in rendering.
@ -108,47 +108,46 @@ raising any errors.
Our demo site is here:
http://andreasgal.github.com/pdf.js/web/viewer.html
+ http://andreasgal.github.com/pdf.js/web/viewer.html
You can read more about pdf.js here:
http://andreasgal.com/2011/06/15/pdf-js/
http://blog.mozilla.com/cjones/2011/06/15/overview-of-pdf-js-guts/
Follow us on twitter: @pdfjs
http://twitter.com/#!/pdfjs
Join our mailing list:
dev-pdf-js@lists.mozilla.org
Subscribe either using lists.mozilla.org or Google Groups:
https://lists.mozilla.org/listinfo/dev-pdf-js
https://groups.google.com/group/mozilla.dev.pdf-js/topics
+ http://andreasgal.com/2011/06/15/pdf-js/
+ http://blog.mozilla.com/cjones/2011/06/15/overview-of-pdf-js-guts/
Talk to us on IRC:
#pdfjs on irc.mozilla.org
+ #pdfjs on irc.mozilla.org
Join our mailing list:
+ dev-pdf-js@lists.mozilla.org
Subscribe either using lists.mozilla.org or Google Groups:
+ https://lists.mozilla.org/listinfo/dev-pdf-js
+ https://groups.google.com/group/mozilla.dev.pdf-js/topics
Follow us on twitter: @pdfjs
+ http://twitter.com/#!/pdfjs
## Additional resources to understand the structure of PDF
A really basic overview of PDF is described here:
http://partners.adobe.com/public/developer/en/livecycle/lc_pdf_overview_format.pdf
+ http://partners.adobe.com/public/developer/en/livecycle/lc_pdf_overview_format.pdf
A more detailed file example:
http://gnupdf.org/Introduction_to_PDF
+ http://gnupdf.org/Introduction_to_PDF
The PDF specification itself is an ISO and not free available. However, there is
The PDF specification itself is an ISO and not freely available. However, there is
a "PDF Reference" from Adobe:
http://wwwimages.adobe.com/www.adobe.com/content/dam/Adobe/en/devnet/pdf/pdfs/pdf_reference_1-7.pdf
+ http://wwwimages.adobe.com/www.adobe.com/content/dam/Adobe/en/devnet/pdf/pdfs/pdf_reference_1-7.pdf
Recommanded chapters to read: "2. Overview", "3.4 File Structure",
Recommended chapters to read: "2. Overview", "3.4 File Structure",
"4.1 Graphics Objects" that lists the PDF commands.