Commit 2ba7907a authored by shubham mukherjee's avatar shubham mukherjee

readme update

parent 7f35006c
......@@ -37,13 +37,22 @@ Note that the jar itself does *not* contain any hadoop libraries. It has to be u
##### Import the code
1. Import the code from `gesall-core` repository into Eclipse.
2. Add `gesall-htsjdk` and `gesall-picard` Eclipse projects to dependencies in `Project->Properties->Java Build Path->Projects`.
3. Add all the external JAR files from `gesall-libs` into `Project->Properties->Java Build Path->Libraries`.
*OR Alternatively*
2. First build the `gesall-htsjdk` and `gesall-picard` individually (using thier respective ant build scripts) and add the appropriate jar files out of the ones that were generated:
Specifically, Add `gesall-htsjdk/dist/htsjdk-xxx.jar` and `gesall-picard/dist/picard-xxx.jar` to the Eclipse Build Path.
3. Add all the other external JAR files from `gesall-libs` into `Project->Properties->Java Build Path->Libraries`.
##### Building the jars
1. Use `File->Export->Runnable JAR` option with library handling set to `Extract required libraries into generated JAR`.
2. This will create a self-contained, fat JAR file.
3. Apache Hadoop JAR files in `gesall-libs` should be of the same version as the deployment Hadoop cluster.
In order to build using an IDE, we have to add the Hadoop jars as well. Hadoop jars are NOT provided in `gesall-libs` or other directories.
1. Add approriate Apache Hadoop Jars, from an external source of your choosing. Note the Hadoop version.
2. Use `File->Export->Runnable JAR` option with library handling set to `Extract required libraries into generated JAR`.
3. Coose the Main-Class which should be the entrypoint for the module in the dropdown `Launch Configuration` menu.
4. Repeat Steps 2 and 3 for each module you need to get a runnable jar for, choosing the appropriate Main .java file.
5. This will create a self-contained JAR files.
Note: Apache Hadoop JAR files which you have added, should be of the same version as the deployment Hadoop cluster.
### License
Our code is released under MIT license.
Our code is released under MIT license.
\ No newline at end of file
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment