Permalink
Browse files

Update README

  • Loading branch information...
1 parent f0aa67c commit 8491c2b8c75c10b682d59d85e89274daf4ea7945 @Klortho Klortho committed Dec 10, 2012
Showing with 33 additions and 3 deletions.
  1. +33 −3 README.md
View
@@ -1,4 +1,34 @@
-PubReader
-=========
+# NLM/NCBI PubReader
+
+This is a suite of Javascript and CSS files for rendering journal articles in a
+PubReader view.
+
+
+## Quick Start
+
+Create a directory that is served by an HTTP server. Then, from a bash shell with
+that as the current working directory:
+
+ git clone https://github.com/NCBITools/PubReader.git
+ cd test
+ ./make-test-pages.sh
+
+Point your browser to http://<em>location</em>/PubReader/test/test-article.html,
+where _location_ is the domain and path of the repository parent directory, as served
+by your HTTP server.
+
+
+## Public domain notice
+
+This work is in the public domain and may be reproduced, published or
+otherwise used without the permission of the National Library of Medicine (NLM).
+
+We request only that the NLM is cited as the source of the work.
+
+Although all reasonable efforts have been taken to ensure the accuracy and
+reliability of the software and data, the NLM and the U.S. Government do
+not and cannot warrant the performance or results that may be obtained by
+using this software or data. The NLM and the U.S. Government disclaim all
+warranties, express or implied, including warranties of performance,
+merchantability or fitness for any particular purpose.
-A new way to view journal articles

0 comments on commit 8491c2b

Please sign in to comment.