Page History

...

Table of Contents

Projects

If you are interested in working on Joshua, and are looking for project ideas, a good place to start is by looking at the roadmap for the next release. You can also see the complete list of issues. 

Installing Joshua and Dependencies

Eclipse setup

See the Getting Started page for information on getting Joshua set up. 

Eclipse

1. Make sure you have set up Joshua, including downloading and installing KenLM, if you want to use that.
2. Clone Joshua from its github location:
   git clone https://github.com/apache/incubator-joshua
    In Eclipse, go to File → Import → Maven → Existing Maven Project. Click Next, then navigate to the root of your cloned Joshua repo. Click OK. Joshua's pom.xml should be selected. Add it to your working set and capitalize it, if you prefer. Click Finish.
3. Next, you need to install the TestNG plugin. Go to Help → Eclipse Marketplace. Search for "testng", choose "TestNG for Eclipse", and click Install. Go through the installation procedure, which is straightforward.

...

You also need to set an environment variable so the tests can find KenLM. That is done on the Arguments tab, in the "VM arguments" box:

Testing

We strive to ensure that the code we release on this project works as expected. When making a contribution to the project be sure to run the test suites for the relevant components before submitting your contribution. If you are working with Joshua from source, you should have Apache Maven installed which can can be used to run the unit tests.

cd $JOSHUA_HOME
mvn test

Creating a Pull Request on Github 

...