Merge pull request #26 from jazz-community/rewrite-to-development-env…

…ironment

Rewrite to development environment

.gitignore

@@ -1,20 +1,26 @@
-# content ignored due to licensing if its content 
-workspace
-derby.log
-conf/jetty/gen/
-conf/jetty/p2/
+target/
+pom.xml.tag
+pom.xml.releaseBackup
+pom.xml.versionsBackup
+pom.xml.next
+release.properties
+dependency-reduced-pom.xml
+buildNumber.properties
+.mvn/timing.properties
 
-# migration of configuration files, this will be able to be removed 
-# again later
-#conf/jetty/user_configs/sdk_files.cfg
+# Avoid ignoring Maven wrapper jar file (.jar files are usually ignored)
+!/.mvn/wrapper/maven-wrapper.jar
 
-scripts/my_*
-
-# gradle
-.gradle/
-
-# idea
-.idea/
-*.iml
+.gradle
+**/build/
+gradle-app.setting
+!gradle-wrapper.jar
+.gradletasknamecache
+.idea
 
+jde/
+jde-slim/
+backup/
+jazz-debug-environment-2.iml
 *.swp
+buildSrc/out

README.md

@@ -0,0 +1,40 @@
+# Jazz Development Environment
+## Introduction
+Jazz Development Environment provides you with tooling for developing RTC Plugins. Main features include running a jetty server for hot deployment and live debugging of jazz plugins.
+
+Setup and usage is handled in a convention over configuration style, which keeps editing files and dealing with setup to a minimum. It is mainly focused on how `jazz-community` plugins are developed, but all related tools are open sourced under the [jazz community](https://github.com/jazz-community/) organization.
+
+## Wiki Table Of Contents
+The [Wiki](https://github.com/jazz-community/jazz-debug-environment/wiki) covers a vast amount of topics on how to work with the jazz development environment.
+
+* [Home](Home)
+* [Quick Start](https://github.com/jazz-community/jazz-debug-environment/wiki/2.0-Quick-Start)
+  * [Requirements](https://github.com/jazz-community/jazz-debug-environment/wiki/2.1-Requirements)
+  * [Instructions](https://github.com/jazz-community/jazz-debug-environment/wiki/2.2-Instructions)
+* [User Guide](https://github.com/jazz-community/jazz-debug-environment/wiki/3.0-User-Guide)
+  * [Links](https://github.com/jazz-community/jazz-debug-environment/wiki/3.1-Links)
+  * [Using the command line](https://github.com/jazz-community/jazz-debug-environment/wiki/3.2-Using-the-command-line)
+    * [Windows](https://github.com/jazz-community/jazz-debug-environment/wiki/3.2.1-Windows)
+    * [Linux](https://github.com/jazz-community/jazz-debug-environment/wiki/3.2.2-Linux)
+  * [Using Intellij](https://github.com/jazz-community/jazz-debug-environment/wiki/3.3-Using-IntelliJ)
+  * [Plugins](https://github.com/jazz-community/jazz-debug-environment/wiki/3.4-Plugins)
+  * [Debugging](https://github.com/jazz-community/jazz-debug-environment/wiki/3.5-Debugging)
+  * [Custom Parameters](https://github.com/jazz-community/jazz-debug-environment/wiki/3.6-Custom-Parameters)
+  * [Migration](https://github.com/jazz-community/jazz-debug-environment/wiki/3.7-Migration)
+* [Tasks](https://github.com/jazz-community/jazz-debug-environment/wiki/5.0-Tasks)
+  * [Bootstrap](https://github.com/jazz-community/jazz-debug-environment/wiki/5.1-Bootstrap)
+  * [Setup](https://github.com/jazz-community/jazz-debug-environment/wiki/5.2-Setup)
+  * [Info](https://github.com/jazz-community/jazz-debug-environment/wiki/5.3-Info)
+  * [Run](https://github.com/jazz-community/jazz-debug-environment/wiki/5.4-Run)
+  * [Backup](https://github.com/jazz-community/jazz-debug-environment/wiki/5.5-Backup)
+* [Developer Guide](https://github.com/jazz-community/jazz-debug-environment/wiki/6.-Developer-Guide)
+* [FAQ](https://github.com/jazz-community/jazz-debug-environment/wiki/7.-FAQ)
+
+## Contributing
+Please use the [Issue Tracker](https://github.com/jazz-community/jazz-debug-environment/issues) of this repository to report issues or suggest enhancements.
+
+For general contribution guidelines, please refer to [CONTRIBUTING.md](https://github.com/jazz-community/welcome/blob/master/CONTRIBUTING.md).
+
+## Licensing
+Copyright (c) Siemens AG. All rights reserved.<br>
+Licensed under the [MIT](https://github.com/jazz-community/rtc-git-connector/blob/master/LICENSE) License.