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 46e52743 minor changes to Xerces-J readme file on this src code repos
location
46e52743 is described below
commit 46e52743a05a7e5c41d3883c2cb9885d4d1f06cf
Author: Mukul Gandhi <[email protected]>
AuthorDate: Fri Apr 26 15:28:44 2024 +0530
minor changes to Xerces-J readme file on this src code repos location
---
README | 81 ++++++++++++++++++++++++++++++++++++++++++++++--------------------
1 file changed, 57 insertions(+), 24 deletions(-)
diff --git a/README b/README
index f7e053b6..d1ff6ae2 100644
--- a/README
+++ b/README
@@ -19,45 +19,78 @@
* limitations under the License.
===========================================================================
-To build Xerces-J from its sources, following steps needs to be followed.
+ Document author : Apache Xerces-J team
<[email protected]>
+
+ Document status
: Draft
+
-1) Getting Xerces-J src code to build
+Xerces-J's project url : https://xerces.apache.org/xerces2-j/
-Xerces-J may be built from its src code, in following two mutually exclusive
ways:
+This software git repos contains Xerces-J's src code and other relevant files,
that together
+provides support for the following standards and APIs:
+
+ XML 1.0 (4th Edition)
+ Namespaces in XML 1.0 (2nd Edition)
+ XML 1.1 (2nd Edition)
+ Namespaces in XML 1.1 (2nd Edition)
+ W3C XML Schema 1.0 (2nd Edition)
+ W3C XML Schema 1.1
+ W3C XML Schema Definition Language (XSD): Component Designators (Candidate
Recommendation, January 2010)
+ XInclude 1.0 (2nd Edition)
+ OASIS XML Catalogs 1.1
+ SAX 2.0.2
+ DOM Level 3 Core, Load and Save
+ DOM Level 2 Core, Events, Traversal and Range
+ Element Traversal (org.w3c.dom.ElementTraversal)
+ JAXP 1.4
+ StAX 1.0 Event API (javax.xml.stream.events)
+
+
+To build Xerces-J from corresponding src and other relevant files, following
steps
+needs to be followed:
+
+1) Getting Xerces-J src and other relevant files for the build
+
+Xerces-J may be built from its src code, in following two different 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,
+number) and extract them within the same file-system directory. If you're
using 'Linux',
download the equivalent .tar.gz files instead of the .zip files.
-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.
+1.2) If you wish to build Xerces-J's development src 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 points.
+
+2) You also need to have JDK version 1.8 installed on your system.
-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.
+Before initiating any part of the build, set the JAVA_HOME environment
variable to the
+installation directory of your JDK.
-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 MS windows batch file and a Unix
-shell script are included.
+3) Ant build software tool may be used to build everything available within
Xerces-J,
+including Xerces-J's documentation. An ant software build tool, and the others
needed (besides the
+pre-requisite JDK) are contained within Xerces-J's tools package. To be able
to build these Xerces-J
+software packages easily, the needed 'MS windows' batch file and also an
'Linux' shell script are included.
-If you only want to compile the source code and make the JAR files,
-run the following command on MS windows:
+If you only wish to compile Xerces-J's src code and produce corresponding Java
jar files,
+run the following command on an 'MS windows' workstation:
build.bat jars
-or from Unix (make sure that build.sh is executable):
+or, from an 'Linux' workstation:
build.sh jars
-This will 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.
+This will compile all of the source code and generate the jar
+files that're available as part of Xerces-J's binary package. After
+these Xerces-J build steps, 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"
+If you'd wish to build everything within Xerces-J, including the documentation,
+run the build batch file (or, shell script) specifying an Ant software's "all"
target instead of "jars".
+
+4) Xerces-J XML Schema language software test suite location
+
+ 4.1) For, XML Schema 1.0 :
https://github.com/apache/xerces-j/tree/main/xml-schema-1.0-tests
+
+ 4.2) For, XML Schema 1.1 :
https://github.com/apache/xerces-j/tree/main/xml-schema-1.1-tests
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
