aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBen Linskey2013-12-16 20:35:27 -0500
committerBen Linskey2013-12-16 20:35:27 -0500
commitb7596dd9ac19356402d90be4264e3e651aff6029 (patch)
treee1331c5f19cbd6017d878b8d718233db79d602cd
parent51698678dacc760fc21a254d71a1c949420cae4e (diff)
downloadgreek-reference-database-creator-1.0.tar.gz
Update readme.v1.0
-rw-r--r--README.md43
1 files changed, 32 insertions, 11 deletions
diff --git a/README.md b/README.md
index ce64df3..7493e9e 100644
--- a/README.md
+++ b/README.md
@@ -6,18 +6,39 @@ This program creates the SQLite database used in the [Greek Reference][] app for
This version of GRDBC is designed to work with a new version of Greek Reference that will be hosted on GitHub. It replaces the old version of GRDBC currently hosted on Bitbucket and is incompatible with the version of Greek Reference currently hosted on Bitbucket.
-[Greek Reference]: https://github.com/blinskey/greek-reference
+## Dependencies
+
+- SQLite3
+- Apache Ant (for compilation)
+
+## Compilation
+
+Run `ant` from the project's root directory to build the JAR.
+
+## Usage
+
+ java -jar grdbc.jar [option]
-### Texts ###
+ Options:
+ -a Create all databases
+ -l Create lexicon database
+ -g Create grammar database
-This project includes the text of _An Intermediate Greek-English Lexicon_, by Henry George Liddell
-and Robert Scott. Text provided by Perseus Digital Library, with funding from The Annenberg
-CPB/Project. Original version available for viewing and download at
-http://www.perseus.tufts.edu/hopper/.
+## Third-Party Libraries
-The project also includes the text of _Overview of Greek Syntax_, by Jeffrey A. Rydberg-Cox. Text
-provided by Perseus Digital Library, with funding from The Annenberg CPB/Project. Original version
-available for viewing and download at http://www.perseus.tufts.edu/hopper/.
+This program uses the following third-party libraries. Thanks to their authors for making their work available.
-The above texts are licensed under a Creative Commons Attribution-ShareAlike 3.0 United States
-License. See http://creativecommons.org/licenses/by-sa/3.0/us/ for details. \ No newline at end of file
+- [EpiDoc TransCoder][]
+- [SQLite JDBC Driver][]
+
+## Texts
+
+This project includes the text of *An Intermediate Greek-English Lexicon*, by Henry George Liddell and Robert Scott. Text provided by Perseus Digital Library, with funding from The Annenberg CPB/Project. Original version available for viewing and download at http://www.perseus.tufts.edu/hopper/.
+
+The project also includes the text of *Overview of Greek Syntax*, by Jeffrey A. Rydberg-Cox. Text provided by Perseus Digital Library, with funding from The Annenberg CPB/Project. Original version available for viewing and download at http://www.perseus.tufts.edu/hopper/.
+
+The above texts are licensed under a Creative Commons Attribution-ShareAlike 3.0 United States License. See http://creativecommons.org/licenses/by-sa/3.0/us/ for details.
+
+[Greek Reference]: https://github.com/blinskey/greek-reference
+[EpiDoc TransCoder]: http://sourceforge.net/projects/epidoc/
+[SQLite JDBC Driver]: https://bitbucket.org/xerial/sqlite-jdbc