Merge pull request #40 from apache/dependabot/maven/freemarker-generator-tools/com...
[freemarker-generator.git] / README.md
index 1ab5a81683dbefe995c3f68ba9a6d8de8b7fe67c..3c9770e66b90073378735bf0f8b5776ebdf049e6 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,37 +1,45 @@
-Apache FreeMarker Generator\r
-===========================\r
-\r
-For documentation or to report bugs visit:\r
-https://freemarker.apache.org/generator.html\r
-\r
-\r
-Regarding pull requests on Github\r
----------------------------------\r
-\r
-By sending a pull request you grant the Apache Software Foundation\r
-sufficient rights to use and release the submitted work under the\r
-Apache license. You grant the same rights (copyright license, patent\r
-license, etc.) to the Apache Software Foundation as if you have signed\r
-a [Contributor License Agreement](https://www.apache.org/dev/new-committers-guide.html#cla).\r
-For contributions that are judged to be non-trivial, you will be asked\r
-to actually signing a Contributor License Agreement.\r
-\r
-\r
-What is Apache FreeMarker Generator?\r
-------------------------------------\r
-\r
-FreeMarker Generator is a tool that generates files based on FreeMarker\r
-templates and data that's typically provided in files (such as JSON files) as\r
-well. It can be used to generated source code, configuration files, etc.\r
-\r
-Currently it can be invoked as a Maven plug-in, but in the future it might\r
-will be callable on other ways (say, from Gradle, or as a standalone command\r
-line tool).\r
-\r
-\r
-Licensing\r
----------\r
-\r
-Apache FreeMarker Generator is licensed under the Apache License, Version 2.0.\r
-\r
-See the LICENSE file for more details!\r
+Apache FreeMarker Generator
+=============================================================================
+
+For documentation or to report bugs visit: [https://freemarker.apache.org](https://freemarker.apache.org)
+
+Regarding pull requests on GitHub
+-----------------------------------------------------------------------------
+
+By sending a pull request you grant the Apache Software Foundation
+sufficient rights to use and release the submitted work under the
+Apache license. You grant the same rights (copyright license, patent
+license, etc.) to the Apache Software Foundation as if you have signed
+a [Contributor License Agreement](https://www.apache.org/dev/new-committers-guide.html#cla).
+For contributions that are judged to be non-trivial, you will be asked
+to actually signing a Contributor License Agreement.
+
+What is Apache FreeMarker Generator?
+-----------------------------------------------------------------------------
+
+FreeMarker Generator is a set of tools that generates files based on FreeMarker
+templates and data that's typically provided in files (such as JSON files) as
+well. It can be used to generated source code, configuration files, etc.
+
+Currently it can be invoked as a 
+
+* Command-line interface `freemarker-generator`
+* Maven plug-in `freemarker-generator-maven-plugin`
+
+Building Apache FreeMarker Generator
+-----------------------------------------------------------------------------
+
+To create the artifacts locally run
+
+> mvn clean install
+
+To build the documentation site run
+
+> mvn clean site site:stage
+
+Licensing
+-----------------------------------------------------------------------------
+
+Apache FreeMarker Generator is licensed under the Apache License, Version 2.0.
+
+See the LICENSE file for more details!