This is an automated email from the ASF dual-hosted git repository.
mukulg pushed a commit to branch xml-schema-1.1-dev
in repository https://gitbox.apache.org/repos/asf/xerces-j.git
The following commit(s) were added to refs/heads/xml-schema-1.1-dev by this
push:
new d07480614 committing few changes to xerces-j readme document
d07480614 is described below
commit d07480614fb7950bb9a7779bd13548378b4d6e27
Author: Mukul Gandhi <[email protected]>
AuthorDate: Sat Oct 12 18:00:03 2024 +0530
committing few changes to xerces-j readme document
---
README | 66 +++++++++++++++++++++++++++++++++++++-----------------------------
1 file changed, 37 insertions(+), 29 deletions(-)
diff --git a/README b/README
index 4282d9b21..c7624dd79 100644
--- a/README
+++ b/README
@@ -4,11 +4,11 @@
===========================================================================
* Licensed to the Apache Software Foundation (ASF) under one or more
- * contributor license agreements. See the NOTICE file distributed with
+ * contributor license agreements. Please see the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
- * The ASF licenses this file to You under the Apache License, Version 2.0
- * (the "License"); you may not use this file except in compliance with
- * the License. You may obtain a copy of the License at
+ * The ASF licenses this file to you under the Apache License, Version 2.0
+ * (the "License"). You may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
@@ -19,26 +19,36 @@
* 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:
+This Apache Xerces-J GitHub repos branch, contains an XML Schema 1.1
implementation unlike
+branch 'main' which has only XML Schema 1.0 implementation. Other that XML
Schema 1.1 implementation,
+this GitHub branch has support for all XML related specifications that the
branch 'main'
+supports.
- http://xml.apache.org/dist/xerces-j/
+In-fact, this GitHub repos branch has both XML Schema 1.0 and 1.1
implementations within
+the same integrated codebase. An XML Java application can select which XML
Schema version
+to use, by instantiating an appropriate XML Schema factory.
-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
-number) and extract them in the same directory. If you are using Unix,
-download the equivalent .tar.gz files instead of the .zip files.
+Before building Xerces-J, users would need the source package and tools
package
+available from the Apache Xerces-J project's distribution web page:
-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
-build, set the JAVA_HOME environment variable to the installation
-directory of your JDK.
+ https://xerces.apache.org/xerces2-j/
-The Ant program is used to build everything in Xerces, including
+Download both the Xerces2 Xerces-J-src.X.Y.Z-xml-schema-1.1.zip and
Xerces-J-tools.X.Y.Z-xml-schema-1.1.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're using an Unix variant OS like Linux, download the
equivalent .tar.gz files
+instead of the .zip files.
+
+You also need to have a Java Development Kit (JDK) version 1.8 or
+higher installed on your system. The latest Xerces-J codebase on this GitHub
+repos has Java language maximum source/target level requirement of 1.8.
+
+Before initiating any part of the build, set the JAVA_HOME environment
+variable to the installation directory of your JDK.
+
+An Ant (https://ant.apache.org/) build tool is needed 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 Xerces-J packages easier, Windows batch file and a Linux
shell script are included.
If you only want to compile the source code and make the JAR files,
@@ -46,21 +56,19 @@ run the following command on Windows:
build.bat jars
-or from Unix (make sure that build.sh is executable):
+or from Linux (make sure that build.sh is executable):
build.sh jars
-This will compile all of the source code and generate the JAR
+This shall compile all of the source code and generate the JAR
files that are available as part of the binary package. After
-building, these files will be located in the build/ directory.
+having results of these Xerces-J builds, the build results shall 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"
+If all results of Xerces-J build are needed, including the documentation,
+run the build batch file or shell script specifying an Ant build "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
+
+Sincerely,
+Apache Xerces Team
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
