# HG changeset patch # User Omair Majid # Date 1401987660 14400 # Node ID a9c281500b55e84666d0c2deb73bb7191e999244 # Parent 2d12136570852c68ccaa947695cb5969c3fa81f7 Update README to mention projects and exporting diff -r 2d1213657085 -r a9c281500b55 README.md --- a/README.md Thu Jun 05 12:32:42 2014 -0400 +++ b/README.md Thu Jun 05 13:01:00 2014 -0400 @@ -2,9 +2,11 @@ ============================ *Thermostat Tools for Eclipse* is an [eclipse][1] plugin to help create -[thermostat][2] [plugins][3]. It helps by automating the tedious and -error-prone parts of creating thermostat plugins, including the creation of -`thermostat-plugin.xml` files. +[Thermostat][2] [plugins][3]. It helps by automating the tedious and +error-prone parts of creating thermostat plugins, including the creation of a +simple project strucuture, support for creating and modifying +`thermostat-plugin.xml` files and exporting a complete plugin so it can be used +by a Thermostat installation. - Website: https://bitbucket.org/omajid/eclipse-plugin-thermostat - IRC: irc://freenode.net/thermostat @@ -13,6 +15,14 @@ Features -------- +*Thermostat Tools for Eclipse* provides extensive support for creating plugins +for Thermostat. + +*Thermostat Tools for Eclipse* provides support for creating, modifying, +buliding and exporting Thermostat plugin projects. It creates a default project +structure matching that of most of the plugins that are included with +Thermostat and builds them automatically using `maven`. + *Thermostat Tools for Eclipse* provides a GUI editor for manipulating `thermostat-plugin.xml` files. After installing the plugin, eclipse will open all `thermostat-plugin.xml` files (with the correct xml header) using the GUI @@ -21,6 +31,9 @@ With the GUI editor you can easily add, remove and edit commands and extensions that are listed in the `themrostat-plugin.xml` file. +*Thermostat Tools for Eclipse* provides also provides an export wizard to make +it easy to install a plugin so it can be picked up and used by Thermostat. + Building -------- @@ -54,6 +67,15 @@ Running ------- + +Once the plugin is installed, new options will appear in a number of places in Eclipse. + +You can create a new plugin project using `File -> New -> Other` dialog: +`Thermostat Plugin Project`. This will create an appropriate set of projects +with dependencies all set up. It will include a simple `thermostat-plugin.xml` +file. The project can be exported as a plugin using the export wizard into a +Thermostat installation. + Once the plugin is installed, a new option will appear in the `File -> New -> Other` dialog: Thermostat Plugin Descriptor. This will create a new `thermostat-plugin.xml` and bring up the GUI editor for it.