Merge pull request #241 from eharris/240-moreLicenseWork

eharris369 · GitHub Enterprise · commit 70ce323c0208 · 2018-12-10T16:52:33.000-05:00
Issue #240: More license work
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,44 @@
+# Contributing
+
+Anyone can contribute to the Microclimate Tools for VSCode project, and we welcome your contributions!
+
+## Raising issues
+
+Please raise any bug reports on the project's (put a link here). Be sure to search the list to see if your issue has already been raised.
+
+A good bug report is one that make it easy for everyone to understand what you were trying to do and what went wrong. Provide as much context as possible so we can try to recreate the issue.
+
+## Developer Certificate of Origin
+
+If you are contributing changes via a pull request, you must sign-off those changes against the *Developer Certificate of Origin*
+
+```
+Developer's Certificate of Origin 1.1
+
+       By making a contribution to this project, I certify that:
+
+       (a) The contribution was created in whole or in part by me and I
+           have the right to submit it under the open source license
+           indicated in the file; or
+
+       (b) The contribution is based upon previous work that, to the best
+           of my knowledge, is covered under an appropriate open source
+           license and I have the right under that license to submit that
+           work with modifications, whether created in whole or in part
+           by me, under the same open source license (unless I am
+           permitted to submit under a different license), as indicated
+           in the file; or
+
+       (c) The contribution was provided directly to me by some other
+           person who certified (a), (b) or (c) and I have not modified
+           it.
+
+       (d) I understand and agree that this project and the contribution
+           are public and that a record of the contribution (including all
+           personal information I submit with it, including my sign-off) is
+           maintained indefinitely and may be redistributed consistent with
+           this project or the open source license(s) involved.
+```
+To sign off and indicate you have agreed to the DCO, include a message in the following format on each commit in the pull request
+
+```DCO 1.1 Signed-off-by: Random J Developer <random@developer.org>```
diff --git a/README.md b/README.md
@@ -1,20 +1,44 @@
-# microclimate-eclipse-plugin
+# Microclimate Developer Tools for Eclipse
+
+## How to install
+
+Complete the following steps to install Microclimate Developer Tools for Eclipse:
+
+1. Download and install the latest [Eclipse IDE for Java EE Developers](https://www.eclipse.org/downloads/packages/release/) or use an existing installation. The earliest supported version of the Eclipse IDE for Microclimate Developer Tools for Eclipse is 4.8 (Photon).
+2. Install the [Microclimate Developer Tools from Eclipse Marketplace](https://marketplace.eclipse.org/content/microclimate-developer-tools-beta).
+
+## How to use
+
+- Create a new connection to Microclimate:
+    - From the **File** menu select **New** > **Other** > **Microclimate** > **New Microclimate Connection**
+    - Fill in the host (only **localhost** is supported) and port (usually **9090**)
+    - Click the **Test Connection** and then click **Finish**
+- This should open the **Microclimate Explorer** view with the connection expanded to show your projects. If it does not open the view then open it manually:
+    - From the **Window** menu select **Show View** > **Other** > **Microclimate** > **Microclimate Explorer**
+    - Click **Open**
+- Right click on the connection to see the available actions for connections
+- Right click on a project to see the available actions for projects
+
+## Features
+
+- View all Microclimate projects for a connection including the application and build status
+- Import your Microclimate project into the Eclipse workspace
+- Debug **Microprofile/Java EE** and **Spring** applications
+- View application and build logs in the **Console** view
+- Open your application in the default Eclipse browser
+- Integrate Microclimate validation errors into the **Markers** view
+- Open a shell session into a Microclimate application container
+- Open the application monitor page
+- Toggle the project auto build setting
+- Manually initiate project builds
+
+(Add documentation link)
+
+## Contributing
+
+We welcome issues (make this a link) and contributions from the public! See [CONTRIBUTING.md](https://github.ibm.com/dev-ex/microclimate-vscode/tree/master/CONTRIBUTING.md)
 
-# Summary
-Tools for working with Microclimate applications in Eclipse
 
-## Contribute to Microclimate Developer Tools
-1. Clone the repository to your system.
 
-    ```git clone https://github.ibm.com/dev-ex/microclimate-eclipse-plugin```
 
-2. [Optional] Copy 'microclimate-eclipse-plugin' folder to 'microclimate-eclipse-plugin_build' to get a test build. This will keep your source folder intact.
-3. Run a gradle build.
 
-    ```cd microclimate-eclipse-plugin_build/dev```
-    
-    ```./gradlew```
- 
- 4. Test the driver built from Step. 3
- 
-    ```microclimate-eclipse-plugin_build/dev/ant_build/artifacts/microclimate-eclipse-plugin-[Version].vYYYYMMDD_hhmm.zip```
diff --git a/dev/com.ibm.microclimate.base/build.properties b/dev/com.ibm.microclimate.base/build.properties
@@ -11,42 +11,8 @@
 
 bin.includes = feature.xml,\
                feature.properties,\
-               feature_cs.properties,\
-               feature_de.properties,\
-               feature_el.properties,\
-               feature_fr.properties,\
-               feature_es.properties,\
-               feature_in.properties,\
-               feature_it.properties,\
-               feature_ja.properties,\
-               feature_ko.properties,\
-               feature_lt.properties,\
-               feature_pl.properties,\
-               feature_pt.properties,\
-               feature_ru.properties,\
-               feature_sl.properties,\
-               feature_tr.properties,\
-               feature_zh.properties,\
-               feature_zh_TW.properties,\
                notices.html,\
-               license.html,\
-               license_cs.html,\
-               license_de.html,\
-               license_el.html,\
-               license_fr.html,\
-               license_es.html,\
-               license_in.html,\
-               license_it.html,\
-               license_ja.html,\
-               license_ko.html,\
-               license_lt.html,\
-               license_pl.html,\
-               license_pt.html,\
-               license_ru.html,\
-               license_sl.html,\
-               license_tr.html,\
-               license_zh.html,\
-               license_zh_TW.html
+               license.html
                
 
                
diff --git a/dev/com.ibm.microclimate.core/build.properties b/dev/com.ibm.microclimate.core/build.properties
@@ -16,7 +16,6 @@ bin.includes = META-INF/,\
                about.ini,\
                microclimate.png,\
                about.properties,\
-               about.mappings,\
                icons/,\
                plugin.properties,\
                plugin.xml,\
diff --git a/dev/com.ibm.microclimate.ui/src/com/ibm/microclimate/ui/internal/messages/messages.properties b/dev/com.ibm.microclimate.ui/src/com/ibm/microclimate/ui/internal/messages/messages.properties
@@ -44,7 +44,7 @@ StartBuildAction_AlreadyBuildingMsg=The project {0} is already building. Wait fo
 MicroclimateConnectionLabel=MicroclimateConnection:
 MicroclimateDisconnected=Disconnected. Check that Microclimate is running.
 MicroclimateProjectDisabled=Disabled
-MicroclimateConnectionNoProjects=No projects. Use Microclimate to create projects.
+MicroclimateConnectionNoProjects=No projects. Right click and select Create New Project.
 
 RestartInDebugMode=&Restart in Debug Mode
 RestartInRunMode=&Restart in Run Mode
diff --git a/dev/com.ibm.microclimate/build.properties b/dev/com.ibm.microclimate/build.properties
@@ -11,41 +11,7 @@
 
 bin.includes = feature.xml,\
                feature.properties,\
-               feature_cs.properties,\
-               feature_de.properties,\
-               feature_el.properties,\
-               feature_fr.properties,\
-               feature_es.properties,\
-               feature_in.properties,\
-               feature_it.properties,\
-               feature_ja.properties,\
-               feature_ko.properties,\
-               feature_lt.properties,\
-               feature_pl.properties,\
-               feature_pt.properties,\
-               feature_ru.properties,\
-               feature_sl.properties,\
-               feature_tr.properties,\
-               feature_zh.properties,\
-               feature_zh_TW.properties,\
                notices.html,\
-               license.html,\
-               license_cs.html,\
-               license_de.html,\
-               license_el.html,\
-               license_fr.html,\
-               license_es.html,\
-               license_in.html,\
-               license_it.html,\
-               license_ja.html,\
-               license_ko.html,\
-               license_lt.html,\
-               license_pl.html,\
-               license_pt.html,\
-               license_ru.html,\
-               license_sl.html,\
-               license_tr.html,\
-               license_zh.html,\
-               license_zh_TW.html
+               license.html
 
                
