You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@joshua.apache.org by mj...@apache.org on 2016/04/27 19:25:07 UTC
incubator-joshua git commit: JOSHUA-256 Note that Joshua builds and
runs with >= Java 1.8
Repository: incubator-joshua
Updated Branches:
refs/heads/master e9af81f17 -> 6f45d19b1
JOSHUA-256 Note that Joshua builds and runs with >= Java 1.8
Project: http://git-wip-us.apache.org/repos/asf/incubator-joshua/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-joshua/commit/6f45d19b
Tree: http://git-wip-us.apache.org/repos/asf/incubator-joshua/tree/6f45d19b
Diff: http://git-wip-us.apache.org/repos/asf/incubator-joshua/diff/6f45d19b
Branch: refs/heads/master
Commit: 6f45d19b1f9c7bc33c57b7485d99f27bd2e2eda6
Parents: e9af81f
Author: Lewis John McGibbney <le...@jpl.nasa.gov>
Authored: Wed Apr 27 08:23:31 2016 -0700
Committer: Lewis John McGibbney <le...@jpl.nasa.gov>
Committed: Wed Apr 27 08:23:31 2016 -0700
----------------------------------------------------------------------
README.md | 39 ++++++++++++++++++++++-----------------
1 file changed, 22 insertions(+), 17 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-joshua/blob/6f45d19b/README.md
----------------------------------------------------------------------
diff --git a/README.md b/README.md
index 98566bd..343f183 100644
--- a/README.md
+++ b/README.md
@@ -14,32 +14,19 @@ Joshua are:
The latest release of Joshua is always linked to directly from the [Home Page](http://joshua.incubator.apache.org)
-## New in 6.0
+## New in 6.X
-Joshua 6.0 includes the following new features:
+Joshua 6.X includes the following new features:
* A fast phrase-based decoder with the ability to read [Moses](http://statmt.org/moses) phrase tables
* Large speed improvements compared to the previous syntax-based decoder
* Special input handling
* A host of bugfixes and stability improvements
-## Working with "language packs"
-
-Joshua includes a number of "language packs", which are pre-built models that
-allow you to use the translation system as a black box, without worrying too
-much about how machine translation works. You can browse the models available
-for download on the [Joshua website](http://joshua.incubator.apache.org/language-packs/).
-
-## Building new models
-
-Joshua includes a pipeline script that allows you to build new models, provided
-you have training data. This pipeline can be run (more or less) by invoking a
-single command, which handles data preparation, alignment, phrase-table or
-grammar construction, and tuning of the model parameters. See [the documentation](http://joshua.incubator.apache.org/pipeline.html)
-for a walkthrough and more information about the many available options.
-
## Quick start
+Joshua must be run with a Java JDK 1.8 minimum. Anything older than that will not run.
+
To run the decoder in any form requires setting a few basic environment
variables: `$JAVA_HOME`, `$JOSHUA`, and potentially `$MOSES`.
@@ -61,3 +48,21 @@ The basic method for invoking the decoder looks like this:
cat SOURCE | $JOSHUA/bin/joshua-decoder -m MEM -c CONFIG OPTIONS > OUTPUT
Some example usage scenarios and scripts can be found in the [examples/](https://github.com/apache/incubator-joshua/tree/master/examples) directory.
+
+## Working with "language packs"
+
+Joshua includes a number of "language packs", which are pre-built models that
+allow you to use the translation system as a black box, without worrying too
+much about how machine translation works. You can browse the models available
+for download on the [Joshua website](http://joshua.incubator.apache.org/language-packs/).
+
+## Building new models
+
+Joshua includes a pipeline script that allows you to build new models, provided
+you have training data. This pipeline can be run (more or less) by invoking a
+single command, which handles data preparation, alignment, phrase-table or
+grammar construction, and tuning of the model parameters. See [the documentation](http://joshua.incubator.apache.org/pipeline.html)
+for a walkthrough and more information about the many available options.
+
+# License
+Joshua is licensed and released under the permissive [Apache License v2.0](http://www.apache.org/licenses/LICENSE-2.0), a copy of which ships with the Joshua source code.
\ No newline at end of file