From ee235410ffe6459f1ecd0e40cfce03e93776b4d6 Mon Sep 17 00:00:00 2001 From: Ben Soares Date: Mon, 26 Apr 2021 18:27:28 +0100 Subject: [PATCH] JAL-3248 Archived old README. Added new README to point user to doc/building.md --- README | 46 +-------------------------------------------- doc/old_ant_build_README | 47 ++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 48 insertions(+), 45 deletions(-) mode change 100755 => 100644 README create mode 100755 doc/old_ant_build_README diff --git a/README b/README old mode 100755 new mode 100644 index 8172066..480bfaf --- a/README +++ b/README @@ -1,47 +1,3 @@ -Jalview Readme --------------- +Please see doc/building.md for up to date build and running instructions. -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... -[ NOTE: when using the -classpath option with the '*' wildcard, the argument must be quoted to avoid shell expansion of the wildcard, - ALSO, the wildcard MUST be as DIR/* and not DIR/*.jar etc or it will not be interpreted correctly ] - -on Windows use: - java -classpath "JALVIEW_HOME/lib/*;JALVIEW_HOME/jalview.jar" jalview.bin.Jalview -and on MacOS or Linux: - java -classpath "JALVIEW_HOME/lib/*:JALVIEW_HOME/jalview.jar" jalview.bin.Jalview - -Replace JALVIEW_HOME with the full path to Jalview Installation Directory. If building from source: - - java -classpath "JALVIEW_BUILD/dist/*" 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 diff --git a/doc/old_ant_build_README b/doc/old_ant_build_README new file mode 100755 index 0000000..8172066 --- /dev/null +++ b/doc/old_ant_build_README @@ -0,0 +1,47 @@ +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... +[ NOTE: when using the -classpath option with the '*' wildcard, the argument must be quoted to avoid shell expansion of the wildcard, + ALSO, the wildcard MUST be as DIR/* and not DIR/*.jar etc or it will not be interpreted correctly ] + +on Windows use: + java -classpath "JALVIEW_HOME/lib/*;JALVIEW_HOME/jalview.jar" jalview.bin.Jalview +and on MacOS or Linux: + java -classpath "JALVIEW_HOME/lib/*:JALVIEW_HOME/jalview.jar" jalview.bin.Jalview + +Replace JALVIEW_HOME with the full path to Jalview Installation Directory. If building from source: + + java -classpath "JALVIEW_BUILD/dist/*" 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 -- 1.7.10.2