freemarker-notifications mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From ddek...@apache.org
Subject incubator-freemarker-online-tester git commit: README.md improvements
Date Wed, 21 Jun 2017 00:18:59 GMT
Repository: incubator-freemarker-online-tester
Updated Branches:
  refs/heads/master 244f04ad7 -> 71a5020af


README.md improvements


Project: http://git-wip-us.apache.org/repos/asf/incubator-freemarker-online-tester/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-freemarker-online-tester/commit/71a5020a
Tree: http://git-wip-us.apache.org/repos/asf/incubator-freemarker-online-tester/tree/71a5020a
Diff: http://git-wip-us.apache.org/repos/asf/incubator-freemarker-online-tester/diff/71a5020a

Branch: refs/heads/master
Commit: 71a5020afa655d51901183a8dcb7b0140fa0b6d6
Parents: 244f04a
Author: ddekany <ddekany@apache.org>
Authored: Wed Jun 21 02:18:53 2017 +0200
Committer: ddekany <ddekany@apache.org>
Committed: Wed Jun 21 02:18:53 2017 +0200

----------------------------------------------------------------------
 README.md | 25 ++++++++++++++++++++-----
 1 file changed, 20 insertions(+), 5 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/incubator-freemarker-online-tester/blob/71a5020a/README.md
----------------------------------------------------------------------
diff --git a/README.md b/README.md
index 4ae0562..1e8c967 100644
--- a/README.md
+++ b/README.md
@@ -1,8 +1,23 @@
 FreeMarker Online Tester [![Build Status](https://travis-ci.org/apache/incubator-freemarker-online-tester.svg?branch=master)](https://travis-ci.org/apache/incubator-freemarker-online-tester)
[![Coverage Status](https://coveralls.io/repos/github/apache/incubator-freemarker-online-tester/badge.svg?branch=master)](https://coveralls.io/github/apache/incubator-freemarker-online-tester?branch=master)
 ====================
 
-FreeMarker Online Tester is a web page to quickly try template snippets. It's especially
handy if the real application
-doesn't let you iterate quickly, and you have no much FreeMarker experience.
+DISCLAIMER
+----------
+
+Apache FreeMarker Online Tester 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 FreeMarker Online Tester
+--------------------------------
+
+It's a web page to quickly try template snippets, with some simple data-model. It's especially
handy for learning the
+template language.
  
 For a deployed version of this tool you can visit <http://freemarker-online.kenshoo.com/>
(or soon
 <http://try.freemarker.org/>)
@@ -10,8 +25,8 @@ For a deployed version of this tool you can visit <http://freemarker-online.kens
 Development Instructions
 ------------------------
 * Clone the repository to a local directory
-* Run "./gradlew build" from the cloned directory (use JDK 8)
-* If you want to run it using IDEA run "./gradlew cleanidea idea"; this will generate the
IDEA project for you.
+* Run `./gradlew build` from the cloned directory (use JDK 8)
+* If you want to run it using IDEA run `./gradlew cleanidea idea`; this will generate the
IDEA project for you.
 * For running the software from a command line, build `shadowJar` (not `jar`) and then just
issue
   `java -jar build/libs/freemarker-online-<VERSION>.jar server  src/main/resources/freemarker-online.yml`,
then visit
    <http://localhost:8080/>
@@ -19,4 +34,4 @@ Development Instructions
 License
 -------
 
-FreeMarker-Online is licensed under the Apache License, Version 2.0. See LICENSE.txt for
details.
\ No newline at end of file
+FreeMarker-Online is licensed under the Apache License, Version 2.0. See the `LICENSE` file
for details.
\ No newline at end of file


Mime
View raw message