From aaa6f4fe6651995c3f310ffabcaa2912a06d5974 Mon Sep 17 00:00:00 2001 From: Lars Hamann <58341317+h-man2@users.noreply.github.com> Date: Fri, 26 Jan 2024 11:33:59 +0100 Subject: [PATCH] Updated Documentation - Changed description of the build process in INSTALL to Maven build system - Updated some version information --- ChangeLog | 2 +- INSTALL | 36 ++++++++++++++++-------------------- 2 files changed, 17 insertions(+), 21 deletions(-) diff --git a/ChangeLog b/ChangeLog index 9c34d5fbb..c50116551 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,7 +1,7 @@ ************************************************************************ The ChangeLog is discontinued. -Please refer to the NEWS file, the Mantis issue tracking, and the SVN. +Please refer to the NEWS file and the project on GitHub. ************************************************************************ diff --git a/INSTALL b/INSTALL index 0821422fa..8afc978a3 100644 --- a/INSTALL +++ b/INSTALL @@ -6,19 +6,17 @@ --------------- USE is implemented in Java(tm). Therefore, it should run on any -platform on which a Java runtime system (e.g. the Sun JDK) is -available. So far this has been tested mainly on Unix-like platforms -(Solaris and Linux) but it should work also on Windows. If you're -trying to install USE on any other platform, you are on your own, -although this should not be too difficult. +platform on which a Java runtime system (e.g. OpenJDK) is +available. So far this has been tested mainly on Windows platforms +but it should work also on Linux. If you're trying to install USE +on any other platform, you are on your own, although this should +not be too difficult. The distribution of USE comes with full sources. If you want to -compile USE yourself, you will need Sun's Java 2 Development Kit (JDK) -version 1.6.0 or later (see http://java.sun.com) and Apache Ant 1.6.0 -or later. Earlier versions of the JDK and ant may work but have not -been tested. For running all tests, you will need some Unix tools like -GNU make, perl, sed, etc. All of them should be available on any -decent Linux distribution. +compile USE yourself, you will need a Java Development Kit (JDK) +version 15 or later (see https://openjdk.org) and Apache Maven 3.8 +or later. Earlier versions of the JDK and Maven may work but have not +been tested. 2. Compilation @@ -27,7 +25,9 @@ decent Linux distribution. The distribution of USE comes with compiled sources. If you don't want or need to recompile them, you can skip this step! -Otherwise, a simple "ant build" should compile the whole USE package. +Otherwise, a simple "mvn compile" or "mwn verify" should compile +the whole USE package. "mvn verify" will run all tests wheras +"msv compile" ujust compiles. Interaction with USE is done via a command line interface. This will be much more comfortable if you have the GNU readline library @@ -36,14 +36,10 @@ library. For example, it allows bash or emacs-like editing of lines and keeps a history file of recent input. Since the readline library is platform dependent, the interface has to be compiled on your system. Changes to the build file may be necessary for your -environment. The native code has been tested with gcc-2.95.2 and -gcc3. If you don't have the readline library - don't worry. USE will -fall back to a simple input mechanism if it cannot find or load the -readline library at runtime. - -You can optionally do some tests by running "ant test'. This will run -various unit tests and calls USE to compile the specifications in the -example and test directory. There should be no error output. +environment. If you don't have the readline library - don't worry. +USE will fall back to a simple input mechanism if it cannot find or +load the readline library at runtime. + 3. Basic Installation