This is an automated email from the ASF dual-hosted git repository.
mukulg pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/xerces-j.git
The following commit(s) were added to refs/heads/main by this push:
new f9aa84b8 committing few changes to xerces-j README file
f9aa84b8 is described below
commit f9aa84b88bf4032bcc973105e4040b49721790a6
Author: Mukul Gandhi <[email protected]>
AuthorDate: Fri Apr 26 13:12:41 2024 +0530
committing few changes to xerces-j README file
---
README | 37 +++++++++++++++++--------------------
1 file changed, 17 insertions(+), 20 deletions(-)
diff --git a/README b/README
index 4282d9b2..f7e053b6 100644
--- a/README
+++ b/README
@@ -1,6 +1,6 @@
- Xerces Java Build Instructions
- ------------------------------
+ Apache Xerces-J build instructions
+ ----------------------------------
===========================================================================
* Licensed to the Apache Software Foundation (ASF) under one or more
@@ -19,30 +19,34 @@
* limitations under the License.
===========================================================================
-Before building Xerces, you need the source package and tools
-package available from the Apache XML Project's distribution
-web page:
+To build Xerces-J from its sources, following steps needs to be followed.
- http://xml.apache.org/dist/xerces-j/
+1) Getting Xerces-J src code to build
-Download both the Xerces-J-src.X.Y.Z.zip and Xerces-J-tools.X.Y.Z.zip
-files for the appropriate Xerces release (where "X.Y.Z" is the version
+Xerces-J may be built from its src code, in following two mutually exclusive
ways:
+
+1.1) Download both the Xerces-J-src.X.Y.Z.zip and Xerces-J-tools.X.Y.Z.zip
+files for the appropriate Xerces-J release (where "X.Y.Z" is the version
number) and extract them in the same directory. If you are using Unix,
download the equivalent .tar.gz files instead of the .zip files.
-You also need to have a Java Development Kit (JDK) version 1.2 (or
-higher) installed on your system. Before initiating any part of the
+1.2) If you wish to build Xerces-J's development code, you need to do git
clone of
+this repos's branch 'main' and follow the same (i.e, as for point 1) mentioned
+above) build instructions as per following 2) and subsequent points.
+
+2) You also need to have a Java Development Kit (JDK) version 1.8 or higher
+installed on your system. Before initiating any part of the
build, set the JAVA_HOME environment variable to the installation
directory of your JDK.
-The Ant program is used to build everything in Xerces, including
+3) The Ant program is used to build everything in Xerces-J, including
the documentation. This tool, and the others needed (besides the
pre-requisite JDK) are contained within the tools package. To
-make building the packages easier, a Windows batch file and a Unix
+make building the packages easier, a MS windows batch file and a Unix
shell script are included.
If you only want to compile the source code and make the JAR files,
-run the following command on Windows:
+run the following command on MS windows:
build.bat jars
@@ -57,10 +61,3 @@ building, these files will be located in the build/
directory.
If you want to build everything, including the documentation,
run the build batch file (or shell script) specifying the "all"
target instead of "jars".
-
-Details about proprietary XML Schema 1.1 unit tests:
-The XercesJ XML Schema 1.1 deliverables, include a proprietary unit test suite
located in the branch "xs-1.1-tests".
-This is in addition to the Xerces tests that are located at
/xerces-java-xml-schema-1.1-dev/tests. It is advisable
-to always comply to tests in the branch "xs-1.1-tests" whenever changing the
code (in addition to the tests /xerces-java-xml-schema-1.1-dev/tests),
-since the functionality these tests are testing are core part of Xerces
deliverables (one of the important things the
-"xs-1.1-tests" tests test, are the error/warning messages generated during XML
Schema 1.1 validation assessments.
\ No newline at end of file
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
