Repository: incubator-freemarker-online-tester Updated Branches: refs/heads/master 98155678f -> 244f04ad7
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/e8037bc2 Tree: http://git-wip-us.apache.org/repos/asf/incubator-freemarker-online-tester/tree/e8037bc2 Diff: http://git-wip-us.apache.org/repos/asf/incubator-freemarker-online-tester/diff/e8037bc2 Branch: refs/heads/master Commit: e8037bc20f382cb535aea3807703cfe9fa190b4f Parents: 9815567 Author: ddekany <ddek...@apache.org> Authored: Wed Jun 21 02:07:08 2017 +0200 Committer: ddekany <ddek...@apache.org> Committed: Wed Jun 21 02:07:08 2017 +0200 ---------------------------------------------------------------------- README.md | 40 +++++++++++----------------------------- 1 file changed, 11 insertions(+), 29 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-freemarker-online-tester/blob/e8037bc2/README.md ---------------------------------------------------------------------- diff --git a/README.md b/README.md index 03b3566..4ae0562 100644 --- a/README.md +++ b/README.md @@ -1,38 +1,20 @@ -``` - - 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. - -``` - -freemarker-online [![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 [![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 is a tool for any freemarker users to evalaute their freemarker expressions with an input. -You can use it for enabling non developers to develop freemarker templates and evaluate it's values without the need for a developement enviornment. -For a deployed version of this tool you can visit http://freemarker-online.kenshoo.com/ +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. + +For a deployed version of this tool you can visit <http://freemarker-online.kenshoo.com/> (or soon +<http://try.freemarker.org/>) -Development Instuctions +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. -* For running the software from a command line, build `shadowJar` (not `jar`) and then just hit "java -jar build/libs/freemarker-online-0.1.undef.jar server src/main/resources/freemarker-online.yml" - +* 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/> License -------