freemarker-notifications mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From ddek...@apache.org
Subject [03/50] incubator-freemarker git commit: Made README.md more plain-text-viewer friendly.
Date Sat, 05 Aug 2017 14:26:23 GMT
Made README.md more plain-text-viewer friendly.


Project: http://git-wip-us.apache.org/repos/asf/incubator-freemarker/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-freemarker/commit/36fdc7ca
Tree: http://git-wip-us.apache.org/repos/asf/incubator-freemarker/tree/36fdc7ca
Diff: http://git-wip-us.apache.org/repos/asf/incubator-freemarker/diff/36fdc7ca

Branch: refs/heads/2.3
Commit: 36fdc7ca2c7acf5b5f6ed34b2677924374c8efa5
Parents: fef04d8
Author: ddekany <ddekany@apache.org>
Authored: Thu Apr 13 14:53:30 2017 +0200
Committer: ddekany <ddekany@apache.org>
Committed: Thu Apr 13 14:53:30 2017 +0200

----------------------------------------------------------------------
 README.md | 89 ++++++++++++++++++++++++++++------------------------------
 1 file changed, 43 insertions(+), 46 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/incubator-freemarker/blob/36fdc7ca/README.md
----------------------------------------------------------------------
diff --git a/README.md b/README.md
index 7b1b039..e4ad314 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,4 @@
 ```
-
  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
@@ -16,28 +15,29 @@
  KIND, either express or implied.  See the License for the
  specific language governing permissions and limitations
  under the License.
-
 ```
 
 
-Apache FreeMarker {version}   [![Build Status](https://travis-ci.org/apache/incubator-freemarker.svg?branch=2.3-gae)](https://travis-ci.org/apache/incubator-freemarker)
+Apache FreeMarker {version}
 ===========================
- For the latest version or to report bugs visit:
 
- http://freemarker.org/
+[![Build Status](https://travis-ci.org/apache/incubator-freemarker.svg?branch=2.3-gae)](https://travis-ci.org/apache/incubator-freemarker)
 
+For the latest version or to report bugs visit:
+http://freemarker.org/
 
 
 DISCLAIMER
-==========
-  Apache FreeMarker is an effort undergoing incubation at The Apache
-  Software Foundation (ASF). Incubation is required of all newly accepted
-  projects until a further review indicates that the infrastructure,
-  communications, and decision making process have stabilized in a manner
-  consistent with other successful ASF projects. While incubation status is
-  not necessarily a reflection of the completeness or stability of the
-  code, it does indicate that the project has yet to be fully endorsed by
-  the ASF.
+----------
+
+Apache FreeMarker is an effort undergoing incubation at The Apache
+Software Foundation (ASF). Incubation is required of all newly accepted
+projects until a further review indicates that the infrastructure,
+communications, and decision making process have stabilized in a manner
+consistent with other successful ASF projects. While incubation status is
+not necessarily a reflection of the completeness or stability of the
+code, it does indicate that the project has yet to be fully endorsed by
+the ASF.
 
 
 What is Apache FreeMarker?
@@ -87,6 +87,7 @@ If you are using Maven, just add this dependency:
     <version>{version}</version>
   </dependency>
 ```
+
 Otherwise simply copy freemarker.jar to a location where your Java
 application's ClassLoader will find it. For example, if you are using
 FreeMarker in a web application, you probably want to put
@@ -116,56 +117,52 @@ link.
 Local setup
 ===========
 
-First of all, if you haven't yet, download the source release, or checkout FreeMarker from
the source code repository.
+First of all, if you haven't yet, download the source release, or checkout
+FreeMarker from the source code repository.
 
-You need 
-1. JDK 8(!), 
-2. Apache Ant and 
-3. Ivy 
+You need JDK 8(!), Apache Ant and Ivy to be installed. (As of this writing
+it was tested with Ant 1.8.1 and Ivy 2.3.0.). 
 
-to be installed. (As of this writing it was tested with Ant 1.8.1 and Ivy 2.3.0.). 
 
 Ivy Installation
----------------------------
-To install Ivy (but be sure it's not already installed).
-Issue 
-```
-ant download-ivy
-``` 
-which will copy it under ~/.ant/lib. Alternatively, you can copy ivy-<version>.jar
into your Ant home directory "lib" subfolder manually.
+----------------
+
+To install Ivy (but be sure it's not already installed). Issue
+`ant download-ivy` which will copy it under `~/.ant/lib`. Alternatively, you
+can copy `ivy-<version>.jar` into your Ant home directory `lib` subfolder
+manually.
 
 
 Building
----------------------------
+--------
 
-To build freemarker.jar, just issue 
-```
-ant
-```
-in the project root directory, and it should download all dependencies automatically and
build freemarker.jar. 
+To build `freemarker.jar`, just issue `ant` in the project root directory, and
+it should download all dependencies automatically and build freemarker.jar. 
+
+It's recommended to copy `build.properties.sample` into `build.properties`,
+and edit its content to fit your system. (Although basic jar building should
+succeeds without the build.properties file too.)
 
-It's recommended to copy build.properties.sample into build.properties, and edit its content
to fit your system. (Although basic jar building should succeeds without the build.properties
file too.)
 
 Managing dependencies
----------------------------
-If later you change the dependencies in ivy.xml, or otherwise want to re-download some of
them, it will not happen automatically anymore. Issue 
-```
-ant update-deps
-```
+---------------------
+
+If later you change the dependencies in `ivy.xml`, or otherwise want to
+re-download some of them, it will not happen automatically anymore, and you
+must issue `ant update-deps`.
 
 
 Eclipse and other IDE setup
 ===========================
 
-Below you find the step-by-step setup for Eclipse Mars.1. If you are using a different version
or an entierly different IDE, still read this, and try to apply it to your development environment:
+Below you find the step-by-step setup for Eclipse Mars.1. If you are using a
+different version or an entierly different IDE, still read this, and try to
+apply it to your development environment:
 
 - Install Ant and Ivy, if you haven't yet; see earlier.
-- From the command line, run 
-  ```
-  ant clean jar ide-dependencies
-  ```
-   (Note that now the folders "ide-dependencies", "build/generated-sources" and "META-INF"
-  were created.)
+- From the command line, run  `ant clean jar ide-dependencies`
+  (Note that now the folders `ide-dependencies`, `build/generated-sources` and
+  `META-INF` were created.)
 - Start Eclipse
 - You may prefer to start a new workspace (File -> "Switch workspace"), but
   it's optional.


Mime
View raw message