|
| 1 | +PLAST - Java project |
| 2 | +==================== |
| 3 | + |
| 4 | +This project contains: |
| 5 | +---------------------- |
| 6 | + |
| 7 | +1. a sample Java application to illustrate the use of PLAST native binary from a Java |
| 8 | + application; |
| 9 | + |
| 10 | +2. some Fasta sample files to use as query and subject files to run PLAST comparison jobs; |
| 11 | + |
| 12 | +3. PLAST pre-compiled native libraries for Linux, MacOS and Windows; |
| 13 | + |
| 14 | +4. the "plast.jar" library required to develop Java PLAST-based applications; |
| 15 | + |
| 16 | +5. an Ant "build.xml" file to handle the project; type "ant help" in your terminal for more information. |
| 17 | + |
| 18 | +6. ".classpath" and ".project" files to import this project into Eclipse IDE. |
| 19 | + |
| 20 | + |
| 21 | +Requirements |
| 22 | +------------ |
| 23 | + |
| 24 | +1. Oracle Java SDK 1.7 or above; avoid using OpenJDK, etc. |
| 25 | +2. Apache Ant 1.9.1 or above. |
| 26 | + |
| 27 | + |
| 28 | +Testing software |
| 29 | +---------------- |
| 30 | + |
| 31 | +This project is self contained, so you can easily test it on the command-line. Using a terminal, type in the following commands: |
| 32 | + |
| 33 | + ant cmp |
| 34 | + ant run |
| 35 | + |
| 36 | + |
| 37 | +About PLAST binary |
| 38 | +------------------ |
| 39 | + |
| 40 | +Inria/Genscale Team provide PLAST binaries as follows: |
| 41 | + |
| 42 | ++ MacOSX PLAST binary: created on OS 10.7.5 (gcc 4.2) |
| 43 | + |
| 44 | ++ Linux PLAST binary: created on CentOS 6.3 (gcc 4.2.1 ; kernel 2.6.32-279.el6.x86_64 ; GLIBCXX_3.4.13 ; libstdc++.so.6) |
| 45 | + |
| 46 | ++ Windows PLAST binary: created on Windows 7.1 Pro 64bits (MinGW-64/gcc 5.2) |
| 47 | + |
| 48 | +Provided PLAST binaries should work on more recent releases of these OS. However, depending on your system, the provided binaries may not work. In such a case, please download source code and compile it on your system. |
| 49 | + |
| 50 | +Compiling PLAST: [http://plast.gforge.inria.fr/docs/cpp/index.html#compile_plast](http://plast.gforge.inria.fr/docs/cpp/index.html#compile_plast) |
| 51 | + |
| 52 | + |
| 53 | +Developer documentation |
| 54 | +----------------------- |
| 55 | + |
| 56 | +See [https://project.inria.fr/plast/developer-guide/](https://project.inria.fr/plast/developer-guide/) for general documentation. |
| 57 | + |
| 58 | +Plast Java API: [http://plast.gforge.inria.fr/docs/java/](http://plast.gforge.inria.fr/docs/java/). |
| 59 | + |
| 60 | +License |
| 61 | +------- |
| 62 | + |
| 63 | +PLAST is free software; you can redistribute it and/or modify it under the Affero GPL v3 |
| 64 | +license. See http://www.gnu.org/licenses/agpl-3.0.en.html |
| 65 | + |
| 66 | +About Github mirror |
| 67 | +------------------- |
| 68 | + |
| 69 | +PLAST project resides at two locations: |
| 70 | + |
| 71 | +* [Inria Forge](https://gforge.inria.fr/): the official git repository |
| 72 | +* Github: this is a mirror of the Inria Forge repository |
| 73 | + |
| 74 | +The Github repository is auto-updated from Inria GForge. So all commits have to be done by authorized users/developers on the Inria Forge. Otherwise, consider using "Github/pull request" for any update to be done on PLAST. |
0 commit comments