This is an automated email from the ASF dual-hosted git repository.
sgoeschl pushed a commit to branch FREEMARKER-129
in repository https://gitbox.apache.org/repos/asf/freemarker-generator.git
The following commit(s) were added to refs/heads/FREEMARKER-129 by this push:
new 03cd3be FREEMARKER-129 More refactoring and documentation updates
03cd3be is described below
commit 03cd3be367d74b68ed6b5a27a54daca1301d6bcc
Author: Siegfried Goeschl <[email protected]>
AuthorDate: Sun Feb 16 16:19:16 2020 +0100
FREEMARKER-129 More refactoring and documentation updates
---
README.md | 37 +++++++++++++++++++++++++++++++++++++
1 file changed, 37 insertions(+)
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..efc2fc2
--- /dev/null
+++ b/README.md
@@ -0,0 +1,37 @@
+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-cli`
+* Maven plug-in `freemarker-generator-maven-plugin`
+
+
+Licensing
+-----------------------------------------------------------------------------
+
+Apache FreeMarker Generator is licensed under the Apache License, Version 2.0.
+
+See the LICENSE file for more details!
