This is an automated email from the ASF dual-hosted git repository.
michaelo pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/velocity-engine.git
The following commit(s) were added to refs/heads/master by this push:
new dd2ffdbd Skim and correct READMEs
dd2ffdbd is described below
commit dd2ffdbdf613bfa27eba4c5eacd77b4710dbe2f6
Author: Michael Osipov <micha...@apache.org>
AuthorDate: Sat Feb 10 19:11:59 2024 +0100
Skim and correct READMEs
There is not reason to duplicate information from the POM and force devs
to keep the information in sync.
---
README.md | 52 +++------------------------------------
spring-velocity-support/README.md | 2 +-
2 files changed, 4 insertions(+), 50 deletions(-)
diff --git a/README.md b/README.md
index ea45099f..de29536a 100644
--- a/README.md
+++ b/README.md
@@ -4,7 +4,7 @@ Title: Apache Velocity Engine
Welcome to Apache Velocity Engine! Apache Velocity is a general purpose
template engine written in Java. For more information about Velocity,
-please look at the HTML documentation on the [Velocity web
site](http://velocity.apache.org/index.html).
+please look at the HTML documentation on the [Velocity web
site](https://velocity.apache.org/index.html).
Here's a description of the top level directories:
@@ -14,57 +14,11 @@ Here's a description of the top level directories:
spring-velocity-support Velocity Engine factory bean for Spring
framework
src/ Source for parent modules, mainly changelog
-## REQUIREMENTS
-
-Apache Velocity 2.2 will run with any Java runtime engine v1.8 or greater.
-
-Building from source requires Java development kit v1.8 or greater and Maven 3
(3.0.5+).
-
-At compile time, Maven should fetch all engine needed dependencies, which are:
-
-* commons-lang v3.9
-* slf4j-api v1.7.30
-
-plus the following ones, needed for the integrated tests:
-
-* slf4j-simple v1.7.30
-* junit v4.13
-* hsqldb v2.5.0
-* commons-io 2.8.0
-
-At runtime, Velocity only needs:
-
-* commons-lang v3.9+
-* slf4j-api and an slf4j binding, v1.7.30+
-
-## BUILDING APACHE VELOCITY
-
-In order to use the latest version of Apache Velocity, you may want to
-build it.
-
-Building is easy. All components necessary to build are included or
-get downloaded from the internet during the build, except for the Java
- SDK and the Maven build tool. You can find details online on [how to build
-Velocity](http://velocity.apache.org/engine/devel/build.html).
-
-*IMPORTANT* As the Apache Velocity build process wants to download a
-number of jars from the internet, you must be online when you are
-building for the first time.
-
-To build Velocity's jar, just run maven using the command:
-
- mvn
-
-This will create a target/ directory containing the Velocity .jar
-file in each sub-module directory.
-
-Be sure to update your classpath to include Velocity's .jar
-file, or when using a modern servlet container, put it in the
-WEB-INF/lib directory.
+Apache Velocity requires at least Java 8 to run.
## CUSTOMIZING THE PARSER
-Since 2.2, it's possible to [build a custom
parser](http://velocity.apache.org/engine/2.2/developer-guide.html#customizing-the-vtl-parser),
to change some of the characters used by in the VTL syntax: `*`, `@`, `$` and
`#`.
+It is possible to [build a custom
parser](https://velocity.apache.org/engine/2.3/developer-guide.html#customizing-the-vtl-parser),
to change some of the characters used by the VTL syntax: `*`, `@`, `$` and `#`.
Let's say you want to merge some templatized jQuery code full of `$`
characters, you can for instance build you own parser which will use the `ยง`
character as references prefix instead of `$`.
diff --git a/spring-velocity-support/README.md
b/spring-velocity-support/README.md
index c31ab24c..9c2e478d 100644
--- a/spring-velocity-support/README.md
+++ b/spring-velocity-support/README.md
@@ -11,7 +11,7 @@ Example configuration:
class="org.apache.velocity.spring.VelocityEngineFactoryBean">
<property name="velocityProperties">
<props>
- <prop key="resource.loader">class</prop>
+ <prop key="resource.loaders">class</prop>
<prop key="class.resource.loader.class">
org.apache.velocity.runtime.resource.loader.ClasspathResourceLoader
</prop>
