]> git.parisson.com Git - pdf.js.git/commitdiff
Add GettingTheCode section to Readme.md
authorJulian Viereck <julian.viereck@gmail.com>
Sun, 25 Sep 2011 09:44:29 +0000 (11:44 +0200)
committerJulian Viereck <julian.viereck@gmail.com>
Sun, 25 Sep 2011 14:04:23 +0000 (16:04 +0200)
README.md

index c6cf92ede4e8ccacf51f0dbacd65b42dc82b3b84..cbde3e93baba5914e38f1e91227fef4be0a5650b 100644 (file)
--- a/README.md
+++ b/README.md
@@ -27,6 +27,32 @@ For an online demo, visit:
 This demo provides an interactive interface for displaying and browsing PDFs
 using the pdf.js API.
 
+**Getting the code**
+
+To get a local copy of the current code, clone it using git:
+
+```bash
+    git clone git://github.com/andreasgal/pdf.js.git pdfjs
+    cd pdfjs
+```
+
+Next, you need to start a local web server as some browsers don't allow opening
+PDF files for a file:// url:
+
+```bash
+  make server
+```
+
+If everything worked out, you can now serve 
+
+  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
+
+
+
 **Hello world**
 
 For a "hello world" example, take a look at:
@@ -97,6 +123,7 @@ Join our mailing list:
 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
 
 Talk to us on IRC: