Permalink
Browse files

readme updates

  • Loading branch information...
mtigas committed Jun 17, 2013
1 parent ee0482d commit d82449712b13b048b6d3f4e3902616cee3e872d5
Showing with 38 additions and 9 deletions.
  1. +38 −9 README.md
View
@@ -5,8 +5,8 @@ Tabula helps you liberate data tables trapped inside PDF files.
* [Read more about Tabula on OpenNews Source](http://source.mozillaopennews.org/en-US/articles/introducing-tabula/)
* [Check out the (feature-limited) demo](http://tabula.nerdpower.org/)
-© 2012-2013 Manuel Aristarán. Available under MIT License. See `AUTHORS.md`
-and `LICENSE.md`.
+© 2012-2013 Manuel Aristarán. Available under MIT License. See
+[`AUTHORS.md`](AUTHORS.md) and [`LICENSE.md`](LICENSE.md)`.
## Why Tabula?
@@ -19,13 +19,42 @@ a simple web interface:
**Caveat**: Tabula only works on text-based PDFs, not scanned documents.
-## Running Tabula
+## Using Tabula
-### Running a packaged version
+First, make sure you have a recent copy of Java installed. You can
+[download Java here][jre_download]. Tabula requires
+a Java Runtime Environment compatible with Java 6 or Java 7.
-(TODO)
+{**TODO**: Download links are not yet ready.}
-### Running Tabula from source (for developers)
+* **Windows** -- Download `tabula-win.zip` from {TODO}. Unzip the whole thing
+ and open the `tabula.exe` file inside. A browser should automatically open
+ to http://127.0.0.1:8080/ . If not, open your web browser of choice and
+ visit that link.
+
+ To close Tabula, just go back to the console window and press "Control-C"
+ (as if to copy).
+
+* **Mac OS X** -- Download `tabula-mac.zip` from {TODO}. Unzip and open
+ the Tabula app inside. A browser should automatically open
+ to http://127.0.0.1:8080/ . If not, open your web browser of choice and
+ visit that link.
+
+ To close Tabula, find the Tabula icon in your dock, right-click (or
+ control-click) on it, and press "Quit".
+
+* **Other platforms** -- Download `tabula-jar.zip` from {TODO} and unzip it
+ to the directory of your choice. Open a terminal window, and `cd` to inside
+ the `tabula` directory you just unzipped. Then run:
+
+ `java -Dfile.encoding=utf-8 -Xms256M -Xmx1024M -jar build/tabula.jar`
+
+If the program fails to run, double-check that you have [Java installed][jre_download]
+and then try again.
+
+[jre_download]: https://www.java.com/download/
+
+## Running Tabula from source (for developers)
1. Download JRuby. You can install it from its website, or using tools like
`rvm` or `rbenv`
@@ -68,7 +97,7 @@ version of the app.
bundle exec rake war
java -Dfile.encoding=utf-8 -Xms256M -Xmx1024M -jar build/tabula.jar
-#### Building a packaged application version
+### Building a packaged application version
After performing the above steps ("Running Tabula from source"), you can compile
Tabula into a standalone application:
@@ -84,7 +113,7 @@ for Mac OS X users.
You can build .exe files for the Windows target on any platform.
-Download a [3.1.X (beta) copy of Launch4J][1].
+Download a [3.1.X (beta) copy of Launch4J][launch4j].
Unzip it into the Tabula repo so that "launch4j" (with subdirectories "bin", etc.)
is in the repository root.
@@ -119,7 +148,7 @@ needs "tabula.jar" (contained in "build") in the same directory. You can create
zip -r9 tabula_win.zip tabula
rm -fr tabula
-[1]: http://sourceforge.net/projects/launch4j/files/launch4j-3/3.1.0-beta1/
+[launch4j]: http://sourceforge.net/projects/launch4j/files/launch4j-3/3.1.0-beta1/
## Contributing

0 comments on commit d824497

Please sign in to comment.