X-Git-Url: http://source.jalview.org/gitweb/?p=jalview.git;a=blobdiff_plain;f=README;h=eaf226bfded93f7bdbd8f73a273d339a1e63ed40;hp=f2ff147e7d81a1cb1d0fa02d1bb916392dc7ee0b;hb=refs%2Fheads%2Fbug%2FJAL-3049colourCellTooltip;hpb=35209076eaf8b16dfb00be8bc8ec69df51134186 diff --git a/README b/README index f2ff147..eaf226b 100755 --- a/README +++ b/README @@ -1,34 +1,42 @@ -Jalview Readme --------------- - - -The source is available as a tar file and comes complete with the GNU General Public License. - -To build the application you will need a J2SDK 1.4+. - -An Ant build file (build.xml) is provided, you will need to install Apache Ant first. -Run ant to view usage which will display a list of useful build targets. - -You can also use Borland JBuilder to build Jalview. A JBuilder project file (JalviewX.jpx, JalviewApplet.jpx) for both application and applet is provided. - -For more help, read the file doc/building.html - - -################## - -To run application: - -java -Djava.ext.dirs=JALVIEW_HOME/lib -cp JALVIEW_HOME/jalview.jar jalview.bin.Jalview - -Replace JALVIEW_HOME with the full path to Jalview Installation Directory. - -################## - - -If you use a proxy server add - --Dhttp.proxyServer=YOUR.SERVER -Dhttp.proxyPort=YOURPORT - -If the proxy server requires authentication, add - --Dhttp.proxyUser=USERNAME -Dhttp.proxyPassword=PASSWORD +Jalview Readme +-------------- + + +The source is available as a tar file and comes complete with the GNU General Public License. + +To build the application you will need a J2SDK 1.7+. + +An Ant build file (build.xml) is provided, you will need to install Apache Ant first. +Run ant to view usage which will display a list of useful build targets. + +Jalview is primarily developed with eclipse, and a .project file is provided to simplify importing the source into your own eclipse workspace. A NetBeans nbbuild.xml file is also provided for developing Jalview with NetBeans - but this is not officially supported. + +You may also be able to use Borland JBuilder to build Jalview. A JBuilder project file +(JalviewX.jpx, JalviewApplet.jpx) for both application and applet is provided, +but the library dependencies are almost certainly out of date. See the build.xml +for current dependencies. + +For more help, read the file doc/building.html + + +################## + +To run application: + +java -Djava.ext.dirs=JALVIEW_HOME/lib -cp JALVIEW_HOME/jalview.jar jalview.bin.Jalview + +Replace JALVIEW_HOME with the full path to Jalview Installation Directory. If building from source: + +java -Djava.ext.dirs=JALVIEW_BUILD/dist -cp JALVIEW_BUILD/dist/jalview.jar jalview.bin.Jalview + + +################## + + +If you use a proxy server add + +-Dhttp.proxyServer=YOUR.SERVER -Dhttp.proxyPort=YOURPORT + +If the proxy server requires authentication, add + +-Dhttp.proxyUser=USERNAME -Dhttp.proxyPassword=PASSWORD