forked from mozilla/pdf.js
-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Improve the instructions for the 'hello world' example
- Loading branch information
1 parent
f6c1c23
commit 70cba47
Showing
1 changed file
with
12 additions
and
6 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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. |