This is an automated email from the ASF dual-hosted git repository.
elharo 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 ff9831498 Convert readme to markdown (#86)
ff9831498 is described below
commit ff9831498de1a8076faa14dbb7002cc2dadd93b2
Author: Elliotte Rusty Harold <[email protected]>
AuthorDate: Fri Apr 10 11:43:27 2026 +0000
Convert readme to markdown (#86)
* Convert readme to markdown
* Convert readme to markdown
* Convert readme to markdown
* title
* spaces
* update build.xml
* update build.xml
---
README | 70 -------------------------------------------------------------
README.md | 56 +++++++++++++++++++++++++++++++++++++++++++++++++
Readme.html | 41 ------------------------------------
build.xml | 5 ++---
4 files changed, 58 insertions(+), 114 deletions(-)
diff --git a/README b/README
deleted file mode 100644
index 9f2894de5..000000000
--- a/README
+++ /dev/null
@@ -1,70 +0,0 @@
-
- Xerces Java Build Instructions
- ------------------------------
-
-===========================================================================
- * Licensed to the Apache Software Foundation (ASF) under one or more
- * 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
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
-===========================================================================
-
-This Apache Xerces-J GitHub repos branch, contains instructions to build
Xerces-J.
-
-Before building Xerces-J, users need the source package and tools package
-available from the Apache Xerces-J project's distribution web page:
-
- https://xerces.apache.org/xerces2-j/
-
-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're using a Unix
-variant 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
-repo 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.
-
-Ant (https://ant.apache.org/) 1.10.2 or later 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 Xerces-J packages easier, a Windows batch file and a Linux
-shell script are included.
-
-If you only want to compile the source code and make the JAR files,
-run the following command on Windows:
-
- build.bat jars
-
-or from Linux (make sure that build.sh is executable):
-
- ./build.sh jars
-
-This compiles all the source code and generates the JAR
-files that are available as part of the binary package. After
-these Xerces-J builds, the build results are located in the "build" directory.
-
-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".
-
-We use JProfiler (https://www.ej-technologies.com/jprofiler) tool for Java
software run-time
-analysis and optimization of Xerces-J software.
-
-
-Sincerely,
-Apache Xerces Team
diff --git a/README.md b/README.md
new file mode 100644
index 000000000..3cbcaf55e
--- /dev/null
+++ b/README.md
@@ -0,0 +1,56 @@
+
+# Xerces Java Build Instructions
+
+This document contains instructions to build Xerces-J.
+
+Before building Xerces-J, users need the source package and tools package
+available from the [Apache Xerces-J project's distribution web
page](https://xerces.apache.org/xerces2-j/).
+
+To build a particular released version, download both
+the Xerces-J-src.X.Y.Z.zip and Xerces-J-tools.X.Y.Z.zip
+files for that Xerces-J release (where "X.Y.Z" is the version
+number) and extract them in the same directory. If you're using a Unix
+variant like Linux, download the equivalent .tar.gz files instead of
+the .zip files.
+
+To build from head, clone this GitHub repository.
+
+You also need to have the Java Development Kit (JDK) version 1.8 or
+higher installed on your system. The latest Xerces-J codebase on this GitHub
+repo 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.
+
+[Ant](https://ant.apache.org/) 1.10.2 or later 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 Xerces-J packages easier, a Windows batch file and a Linux
+shell script are included.
+
+If you only want to compile the source code and make the JAR files,
+run the following command on Windows:
+
+```
+build.bat jars
+```
+
+or from Linux (make sure that build.sh is executable):
+
+```
+./build.sh jars
+```
+
+This compiles all the source code and generates the JAR
+files that are available as part of the binary package. After
+these Xerces-J builds, the build results are located in the "build" directory.
+
+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".
+
+We use the [JProfiler](https://www.ej-technologies.com/jprofiler) tool for
Java software run-time
+analysis and optimization of Xerces-J software.
+
+Sincerely,<br>
+Apache Xerces Team
diff --git a/Readme.html b/Readme.html
deleted file mode 100644
index 9c07fbb23..000000000
--- a/Readme.html
+++ /dev/null
@@ -1,41 +0,0 @@
-<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0//EN"
"http://www.w3.org/TR/REC-html40/strict.dtd";>
-<!--
- * Licensed to the Apache Software Foundation (ASF) under one or more
- * contributor license agreements. 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
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
--->
-<html>
- <head>
- <meta http-equiv="Refresh" content="3; URL=docs/index.html">
- <title>Xerces Java Parser</title>
- </head>
- <body>
- <h1 align='center'>Xerces Java Parser</h1>
- <h2>Redirecting to Documentation...</h2>
- <p>
- In a few seconds, you should be redirected to the Xerces Java Parser
- documentation. If you are not automatically redirected, please click
- on the following link:
- <blockquote>
- <a href='docs/index.html'>Xerces Java Documentation</a>
- </blockquote>
- </p>
- <p>
- <strong>Note:</strong>
- You must download the binary distribution to get the documentation.
- If you downloaded the source distribution, then you must build the
- documentation first.
- </p>
- </body>
-</html>
diff --git a/build.xml b/build.xml
index 0b998ab3a..277e64055 100644
--- a/build.xml
+++ b/build.xml
@@ -637,8 +637,7 @@ Authors:
<copy file="NOTICE" tofile="${distsrc.dir}/NOTICE"/>
<copy file="LICENSE.DOM-documentation.html"
tofile="${distsrc.dir}/LICENSE.DOM-documentation.html"/>
<copy file="LICENSE.DOM-software.html"
tofile="${distsrc.dir}/LICENSE.DOM-software.html"/>
- <copy file="README" tofile="${distsrc.dir}/README"/>
- <copy file="Readme.html" tofile="${distsrc.dir}/Readme.html"/>
+ <copy file="README.md" tofile="${distsrc.dir}/README.md"/>
<copy file="build.xml" tofile="${distsrc.dir}/build.xml"/>
<copy file="${basedir}/build.sh" tofile="${distsrc.dir}/build.sh" />
<chmod file="${distsrc.dir}/build.sh" perm="ugo+rx" />
@@ -728,7 +727,7 @@ Authors:
<copy file="NOTICE" tofile="${distsrc.dir}/NOTICE"/>
<copy file="LICENSE.DOM-documentation.html"
tofile="${distsrc.dir}/LICENSE.DOM-documentation.html"/>
<copy file="LICENSE.DOM-software.html"
tofile="${distsrc.dir}/LICENSE.DOM-software.html"/>
- <copy file="Readme.html" tofile="${distbin.dir}/Readme.html"/>
+ <copy file="README.md" tofile="${distbin.dir}/README.md"/>
<copy file="${build.dir}/${jar.samples}"
tofile="${distbin.dir}/${jar.samples}"/>
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
