You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@joshua.apache.org by le...@apache.org on 2016/08/24 02:28:56 UTC

incubator-joshua git commit: Update examples README formatting and links.

Repository: incubator-joshua
Updated Branches:
  refs/heads/master ff410c297 -> 5ed36b094


Update examples README formatting and links.


Project: http://git-wip-us.apache.org/repos/asf/incubator-joshua/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-joshua/commit/5ed36b09
Tree: http://git-wip-us.apache.org/repos/asf/incubator-joshua/tree/5ed36b09
Diff: http://git-wip-us.apache.org/repos/asf/incubator-joshua/diff/5ed36b09

Branch: refs/heads/master
Commit: 5ed36b09484ec18fe00a8cb20af9d0e1ba1ca4e7
Parents: ff410c2
Author: Lewis John McGibbney <le...@gmail.com>
Authored: Tue Aug 23 19:36:09 2016 -0700
Committer: Lewis John McGibbney <le...@gmail.com>
Committed: Tue Aug 23 19:36:09 2016 -0700

----------------------------------------------------------------------
 examples/README.md | 34 ++++++++++++++++------------------
 1 file changed, 16 insertions(+), 18 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/incubator-joshua/blob/5ed36b09/examples/README.md
----------------------------------------------------------------------
diff --git a/examples/README.md b/examples/README.md
index 1468372..3681aa1 100644
--- a/examples/README.md
+++ b/examples/README.md
@@ -2,7 +2,7 @@
 
 The examples in this directory demonstrate how to exercise different
 Joshua features. If you have any comments or questions please submit 
-them to [our mailing lists](http://joshua.incubator.apache.org/support/).
+them to [our mailing lists](https://cwiki.apache.org/confluence/display/JOSHUA/Support).
 
 Bugs or source code issues should be logged in our 
 [Issue Tracker](https://issues.apache.org/jira/browse/joshua).
@@ -10,31 +10,28 @@ Bugs or source code issues should be logged in our
 The decoding examples and model training examples in the subdirectories of this
 directory assume you have downloaded the Fisher Spanish--English dataset, which
 contains speech-recognizer output paired with English translations. This data
-can be downloaded by running the [download.sh](https://github.com/apache/incubator-joshua/blob/master/src/examples/resources/download.sh) script.
+can be downloaded by running the [download.sh](https://github.com/apache/incubator-joshua/blob/master/examples/download.sh) script.
 
 # Building a Spanish --> English Translation Model using the Fisher Spanish CALLHOME corpus
 
 An example of how to build a model using the Fisher Spanish CALLHOME corpus
 
 A) Download the corpus:
-    1) mkdir $HOME/git
-    2) cd $HOME/git
-    3) curl -o fisher-callhome-corpus.zip https://codeload.github.com/joshua-decoder/fisher-callhome-corpus/legacy.zip/master
-    4) unzip fisher-callhome-corpus.zip
-    5) # Set environment variable SPANISH=$HOME/git/fisher-callhome-corpus
-    5) mv joshua-decoder-*/ fisher-callhome-corpus
-
-B) Download and install Joshua:
-    1) cd /directory/to/install/
-    2) git clone https://github.com/apache/incubator-joshua.git
-    3) cd incubator-joshua
-    4) # Set environment variable JAVA_HOME=/path/to/java    # Try $(readlink -f /usr/bin/javac | sed "s:/bin/javac::")
-    5) # Set environment variable JOSHUA=/directory/to/install/joshua
-    6) mvn install
+```
+$ mkdir $HOME/git
+$ cd $HOME/git
+$ curl -o fisher-callhome-corpus.zip https://codeload.github.com/joshua-decoder/fisher-callhome-corpus/legacy.zip/master
+$ unzip fisher-callhome-corpus.zip
+$ export SPANISH=$HOME/git/fisher-callhome-corpus
+$ mv joshua-decoder-*/ fisher-callhome-corpus
+```
+
+B) Download and install Joshua as per the [Quickstart](https://github.com/apache/incubator-joshua#quick-start).
 
 C) Train the model:
-    1) mkdir -p $HOME/expts/joshua && cd $HOME/expts/joshua
-    2) $JOSHUA/bin/pipeline.pl \
+```
+$ mkdir -p $HOME/expts/joshua && cd $HOME/expts/joshua
+$ $JOSHUA/bin/pipeline.pl \
         --rundir 1 \
         --readme "Baseline Hiero run" \
         --source es \
@@ -46,3 +43,4 @@ C) Train the model:
         --tune  $SPANISH/corpus/asr/fisher_dev \
         --test  $SPANISH/corpus/asr/callhome_devtest \
         --lm-order 3
+```
\ No newline at end of file