[Pkg-javascript-commits] [pdf.js] 10/119: Improve the instructions for the 'hello world' example

David Prévot taffit at moszumanska.debian.org
Wed May 13 21:27:36 UTC 2015


This is an automated email from the git hooks/post-receive script.

taffit pushed a commit to branch master
in repository pdf.js.

commit 70cba472e0c839daabf620ae8a60cd27bd5d4853
Author: Tim van der Meij <timvandermeij at gmail.com>
Date:   Wed Mar 18 21:22:12 2015 +0100

    Improve the instructions for the 'hello world' example
---
 examples/helloworld/README.md | 18 ++++++++++++------
 1 file changed, 12 insertions(+), 6 deletions(-)

diff --git a/examples/helloworld/README.md b/examples/helloworld/README.md
index d4c7aba..7096b14 100644
--- a/examples/helloworld/README.md
+++ b/examples/helloworld/README.md
@@ -1,10 +1,16 @@
-## "Hello World" overview
+## Overview
 
-This example is a minimalistic application of the PDF.js project. The file
-`helloworld.pdf` originates from the GNUpdf project and contains a simple and
-human-readable PDF.
+The "hello world" example is a minimalistic application of the PDF.js project.
+The file `helloworld.pdf` originates from the GNUpdf project and contains a
+simple and human-readable PDF.
 
 ## Getting started
 
-Point your browser to `index.html`. Voila. Take a peek at `hello.js` to see
-how to make basic calls to `pdf.js`.
+Instead of simply opening `index.html` in a browser, you must serve the page
+using a web server. This can be done on your local machine without an internet
+connection. In the root directory of PDF.js, run `node make server` in a
+terminal. The example can then be viewed using the following URL:
+
+`http://localhost:8888/examples/helloworld/index.html`
+
+Take a look at `hello.js` to see how to make basic calls to PDF.js.

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/pkg-javascript/pdf.js.git



More information about the Pkg-javascript-commits mailing list