This is an automated email from the ASF dual-hosted git repository.
painter pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/turbine-archetypes.git
The following commit(s) were added to refs/heads/master by this push:
new 3d6c056 Update readme
3d6c056 is described below
commit 3d6c0561dabbf82224d764bfe886ebd56b9ab95c
Author: jlpainter <[email protected]>
AuthorDate: Tue Oct 9 10:51:05 2018 -0400
Update readme
---
README.md | 47 +++++++++++++++++++++++++++++++++++++++++++++++
1 file changed, 47 insertions(+)
diff --git a/README.md b/README.md
index 2389115..d05d8bc 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,49 @@
# turbine-webapp-5.0
+
Maven Archetype to generate a webapp utilizing Turbine 5.0
+
+## Getting Started
+
+These instructions will get you a copy of the project up and running on your
local machine for development and testing purposes. See deployment for notes on
how to deploy the project on a live system.
+
+### Prerequisites
+
+* Java 8 JDK or later
+* [MySQl](https://www.mysql.com/) - Database Server
+* [Maven](https://maven.apache.org/) - Dependency Management
+
+You should have Java 8 or later installed. The archetype sets up a new
application using MySQL as the default database store. However, you can adjust
this to use any database supported by Apache Torque 4.0. Therefore, you should
be at least have a database instance where you have access rights to create a
new database schema and populate it with the tables the application generates.
Finally, this is a maven archetype, so of course you should install a local
version of Maven (tested wi [...]
+
+
+### Installing
+
+Eclipse integration:
+
+You need to first add the Apache maven archetypes to your IDE so that you can
take advantage of using the turbine-webapp-5.0 plugin to generate a new web
application.
+
+The location of the remote catalog file is:
http://repo.maven.apache.org/maven2/archetype-catalog.xml
+
+Step-by-step instructions on how to accomplish this can be found here:
https://howtodoinjava.com/eclipse/how-to-import-maven-remote-archetype-catalogs-in-eclipse/
+
+
+## Built With
+
+* [Maven](https://maven.apache.org/) - Dependency Management
+
+## Contributing
+
+Please feel free to contribute. We are always happy to encourage new
committers to the project.
+
+
+## Authors
+
+* **Georg Kallidis**
+* **Jeffery Painter** - [Jivecast](https://jivecast.com)
+
+## License
+
+This project is licensed under the Apache Software License 2.0
+
+## Acknowledgments
+
+* Thanks to the long list of former Apache Turbine developers
\ No newline at end of file
