From 60b31e61332a6600e62dcb0344bd03584209c827 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Tobi=20Sch=C3=A4fer?= <interface@p3k.org>
Date: Wed, 8 Apr 2015 19:00:36 +0200
Subject: [PATCH] Update and rename README.txt to README.md

---
 build/README.md  | 38 +++++++++++++++++++++++++++++++++++
 build/README.txt | 52 ------------------------------------------------
 2 files changed, 38 insertions(+), 52 deletions(-)
 create mode 100644 build/README.md
 delete mode 100644 build/README.txt

diff --git a/build/README.md b/build/README.md
new file mode 100644
index 00000000..bf60ba49
--- /dev/null
+++ b/build/README.md
@@ -0,0 +1,38 @@
+_This is the README file for the Helma build files as part of the Helma Object Publisher._
+
+## Prerequisites
+
+The Helma build script is using Apache Ant. 
+For more information about Ant, see <http://ant.apache.org/>.
+
+## Building
+
+The build system is started by invoking the shell script appropriate to your 
+platform, ie. build.sh for *nix (Linux, NetBSD etc.) and build.bat for Windows 
+systems. You probably need to modify the script and set the `JAVA_HOME` to fit your system.
+
+The generic syntax is
+
+    ant target
+
+The parameter `target` specifies one of the build targets listed below.
+
+## Build Targets
+
+**compile**  
+Compiles the source files into the `./classes` directory (which will be created if necessary).
+
+**jar**  
+Creates a helma.jar file (snapshot) in the lib directory. The file is named `helma-yyyymmdd.jar`.
+
+**javadocs**  
+Creates the JavaDoc API documentation.
+
+**package**  
+Creates the full Helma distribution packages and places them in the dist directory.
+
+**app [name]**  
+Gets an application from the source code repository, zips / targzs it and places the files in the dist directory.
+
+**module [name]**  
+Gets a module from the source code repository, zips it and places the file in the dist directory.
diff --git a/build/README.txt b/build/README.txt
deleted file mode 100644
index 4cd8d0c3..00000000
--- a/build/README.txt
+++ /dev/null
@@ -1,52 +0,0 @@
-This is the README file for the Helma build files as part of the Helma Object Publisher.
-
-PREREQUISITES
-=============
-
-The Helma build script is uses Apache Ant. 
-For more information about Ant, see <http://ant.apache.org/>.
-
-For checking out the source files from Helma's CVS you also need a CVS client. 
-More information about CVS at <http://www.cvshome.org/>.
-
-
-STARTING BUILD
-==============
-
-The build system is started by invoking the shell script appropriate to your 
-platform, ie. build.sh for *nix (Linux, NetBSD etc.) and build.bat for Windows 
-systems. You need to modify the script and set the JAVA_HOME to fit your system.
-
-The generic syntax is
-
-    ant target
-
-The parameter "target" specifies one of the build targets listed below.
-
-
-BUILD TARGETS
-=============
-
-compile
-    Compiles the source files contained in the work/checkout/hop/ directory into the work/classes/ directory (which will be created if necessary).
-
-jar
-    Creates a helma.jar file (snapshot) in the lib-directory. The file is named helma-yyyymmdd.jar.
-
-javadocs
-    Creates the javadoc API documentation.
-
-package
-    Creates the full helma distribution packages and places them in the dist directory.
-
-app [name]
-    Gets an application from the cvs, zips/targzs it and places the files in the dist directory.
-
-module [name]
-    Gets a module from the cvs, zips it and places the file in the dist directory.
-
-
---
-
-
-