diff options
| author | john.j.camilleri <john.j.camilleri@chalmers.se> | 2012-07-10 12:16:28 +0000 |
|---|---|---|
| committer | john.j.camilleri <john.j.camilleri@chalmers.se> | 2012-07-10 12:16:28 +0000 |
| commit | 9e3b89a2a8de1ad24a7ba83042d9441ca1ce6987 (patch) | |
| tree | f95ff4266f92d4b5fb1b0e7b07a8637e7cf24bda /eclipse | |
| parent | 62b295aaeecf5b3e5fcfc665acb70ccc3f8536af (diff) | |
GFEP: updated readme
Diffstat (limited to 'eclipse')
| -rw-r--r-- | eclipse/index.html | 38 |
1 files changed, 35 insertions, 3 deletions
diff --git a/eclipse/index.html b/eclipse/index.html index c454e93fc..fb37736f2 100644 --- a/eclipse/index.html +++ b/eclipse/index.html @@ -10,8 +10,8 @@ <h1>The GF Eclipse Plugin</h1> -<p>John J. Camilleri<br /> -Updated: 12 June 2012</p> +<p>John J. Camilleri<br /> +Updated: 10 July 2012</p> <p><em>The research leading to these results has received funding from the European Union’s Seventh Framework Programme (FP7/2007-2013) under grant agreement no. FP7-ICT-247914 (the <a href="http://www.molto-project.eu/">MOLTO Project</a>).</em></p> @@ -460,7 +460,39 @@ I only support the latest version of the plugin, so make sure you are up to date </ol> <p>In both cases make sure you get the correct version of Xtext (see below). -Once you have Xtext set up, you can clone the repository locally with <code>git clone git://github.com/GrammaticalFramework/gf-eclipse-plugin.git</code> and then add the projects under the <code>workspace</code> directory to your Eclipse workspace.</p> +Once you have Xtext set up, you can clone the repository locally with the following command:</p> + +<pre><code>git clone git://github.com/GrammaticalFramework/gf-eclipse-plugin.git +</code></pre> + +<p>You can then add the projects under the <code>workspace</code> directory to your Eclipse workspace, by using the <strong>File → Import…</strong> wizard. +The individual projects are:</p> + +<dl> +<dt><strong><code>org.grammaticalframework.eclipse</code></strong></dt> +<dd>Main plugin which covers all parsing and linking behaviour.</dd> + +<dt><strong><code>org.grammaticalframework.eclipse.ui</code></strong></dt> +<dd>Covers all UI aspects of the plugin. Depends on <code>org.grammaticalframework.eclipse</code> (but the opposite is not true).</dd> + +<dt><strong><code>org.grammaticalframework.eclipse.tests</code></strong></dt> +<dd>Contains unit tests for the plugin. Not required for running the plugin.</dd> + +<dt><strong><code>org.grammaticalframework.eclipse.ontology-grammar</code></strong></dt> +<dd>GF Ontology Grammar Plugin for Eclipse, developed separately by Ontotext AB.</dd> + +<dt><strong><code>org.grammaticalframework.feature</code></strong></dt> +<dd>Exports all projects packaged as the GF Eclipse Plugin.</dd> + +<dt><strong><code>org.grammaticalframework.updatesite</code></strong></dt> +<dd><em>Unused</em></dd> +</dl> + +<h4>Extra dependencies for unit testing project</h4> + +<p>The unit testing project (<code>org.grammaticalframework.eclipse.tests</code>) has an extra requirement for the library <code>org.eclipselabs.xtext.utils.unittesting</code>, which you will probably get complaints about when importing your projects into Eclipse. +You only need to worry about this if you want to run the unit tests; otherwise you can ignore these errors. +You can get more information about this library <a href="http://code.google.com/a/eclipselabs.org/p/xtext-utils/wiki/Unit_Testing">here</a>, or just install it in Eclipse directly using the following update site URL: <a href="http://xtext-utils.eclipselabs.org.codespot.com/git.distribution/releases/unittesting-0.9.x/">http://xtext-utils.eclipselabs.org.codespot.com/git.distribution/releases/unittesting-0.9.x/</a></p> <h4>Xtext version</h4> |