Skip to content

Commit d67c45a

Browse files
paulvipaulvi
committed
update README; refs Nodeclipse#18 
1 parent 49a8b36 commit d67c45a

File tree

1 file changed

+89
-58
lines changed

1 file changed

+89
-58
lines changed

‎README.md

+89-58
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,12 @@
22
# CoffeeScript Eclipse Plugin
33

44
[![Build Status](https://secure.travis-ci.org/Nodeclipse/coffeescript-eclipse.png)](http://travis-ci.org/Nodeclipse/coffeescript-eclipse)
5+
<a href="http://marketplace.eclipse.org/marketplace-client-intro?mpc_install=1097343" title="Drag and drop into a running Eclipse to install Nodeclipse CoffeeScript Editor">
6+
<img src="http://marketplace.eclipse.org/sites/all/modules/custom/marketplace/images/installbutton.png"/>
7+
</a>
58

69
This is a project to provide an Eclipse plugin for [CoffeeScript][coffeescript], using [Xtext][xtext].
7-
Development uses Xtext 2.1.
10+
Development uses Xtext 2.1 (TODO update to the latest 2.4.3).
811
It works as a regular Eclipse plugin (see Installation for details).
912
Highlights include
1013

@@ -16,13 +19,9 @@ Highlights include
1619
>There are some extra features and some missing,
1720
but you probably (and hopefully) won't notice the difference in everyday use.
1821

19-
<a href="http://marketplace.eclipse.org/marketplace-client-intro?mpc_install=1097343" title="Drag and drop into a running Eclipse to install Nodeclipse CoffeeScript Editor">
20-
<img src="http://marketplace.eclipse.org/sites/all/modules/custom/marketplace/images/installbutton.png"/>
21-
</a>
22-
2322
## Status
2423

25-
<b>Looking for owner<b> and DYI mode
24+
<b>Looking for owner<b> and DIY mode
2625

2726
coffeescript-eclipse has not been updated for a year.
2827
Paul has contacted Adam Schmideg, the original author at FORMULA 400, and got blessing for Nodeclipse
@@ -31,7 +30,7 @@ but tell the world that if there will be a person willing to make maintenance re
3130
and do some refresh (and possibly become project owner),
3231
we will include CoffeeScript Editor into Nodeclipse distributions.
3332

34-
In August 2013 0.3.0 refresh version was released, with no new features, except for icon and igration maven/tycho build.
33+
In August 2013 0.3.0 refresh version was released, with no new features, except for icon and migration to maven/tycho build.
3534

3635
Old issues <https://github.com/adamschmideg/coffeescript-eclipse/issues?state=open>, and <https://bitbucket.org/adamschmideg/coffeescript-eclipse/issues?status=new&status=open>
3736

@@ -40,31 +39,10 @@ Old issues <https://github.com/adamschmideg/coffeescript-eclipse/issues?state=op
4039
If you reference any issues in this repository add "Nodeclipse#", otherwise GitHub searches
4140
in <https://github.com/adamschmideg/coffeescript-eclipse> repository.
4241

43-
## Plans
44-
45-
### 0.4
46-
47-
- make grouping and error warning as optional and disable by default (Reason: there are a lot of tiny problem, false error detection.
48-
They are distracting developer.)
49-
50-
## Changelog
51-
52-
Check [devjournal.md](https://github.com/Nodeclipse/coffeescript-eclipse/blob/master/devjournal.md)
42+
## Details
5343

54-
- 0.3.0 refresh release
55-
- switch to maven/tycho build
56-
- coffee icon
44+
### Extra features
5745

58-
<dl>
59-
<dt>0.2.2</dt>
60-
<dd>Embed coffeescript in a DSL (see the `example` directory)</dd>
61-
<dt>Planned next release</dt>
62-
<dd>Integrated build: convert coffee code to javascript, and run it</dd>
63-
</dl>
64-
65-
66-
67-
## Extra features
6846
CoffeeScript is a dynamic language,
6947
the parser doesn't check the types or even the existence of variables,
7048
such mismatches are detected at runtime.
@@ -85,7 +63,8 @@ It works within string interpolation, too, so the next snippet will also give a
8563

8664
Note that the `console` variable won't cause any warning, it's handled as a built-in variable.
8765

88-
## Incompatibilities
66+
### Incompatibilities
67+
8968
The plugin handles properly most language constructs,
9069
including all examples in the coffeescript documentation folder.
9170
There are two cases it cannot handle, though, post-increment and
@@ -112,15 +91,89 @@ Getting the value of a deeply nested property is OK.
11291
borrow(my.secret.money)
11392
borrowed = my.secret.money
11493

115-
# Building
94+
## Installation
11695

117-
## Building with Maven / Tycho
96+
in a word: drag-and-drop
97+
<a href="http://marketplace.eclipse.org/marketplace-client-intro?mpc_install=1097343" title="Drag and drop into a running Eclipse to install Nodeclipse CoffeeScript Editor">
98+
<img src="http://marketplace.eclipse.org/sites/all/modules/custom/marketplace/images/installbutton.png"/>
99+
</a>
118100

119-
To start a headless build using maven, simply run `mvn` in the root of the project.
101+
1. Get [Enide Studio](http://www.nodeclipse.org/enide/studio/) from <http://sourceforge.net/projects/nodeclipse/files/Enide-Studio/>
102+
or latest Eclipse Kepler from <http://www.eclipse.org/downloads/>.
103+
2. [Enide Studio](http://www.nodeclipse.org/enide/studio/) and [Eclipse IDE for Java and DSL Developers](http://www.eclipse.org/downloads/packages/eclipse-ide-java-and-dsl-developers/keplerr)
104+
both have required XText. Any Eclipse from <http://www.eclipse.org/downloads/> can actually download the dependency automatically.
105+
For Eclipse version before Kepler there is [quick installer on Marketplace](http://marketplace.eclipse.org/content/coffeescript-editor-quick-installer).
106+
3. Use drag-and-drop
107+
<a href="http://marketplace.eclipse.org/marketplace-client-intro?mpc_install=1097343" title="Drag and drop into a running Eclipse to install Nodeclipse CoffeeScript Editor">
108+
<img src="http://marketplace.eclipse.org/sites/all/modules/custom/marketplace/images/installbutton.png"/>
109+
</a>
110+
or update site `http://www.nodeclipse.org/coffeescript/repository/`
120111

121-
## Install from sources
112+
Below is original detailed instructions:
113+
114+
#### Installation (old way 0.2.2)
122115

123-
1. `mvn package` or `mvn -o package` for offline re-build
116+
You will need an Eclipse instance with Xtext plugins.
117+
You can either install a complete Indigo distribution with Xtext,
118+
or install the required plugins into your existing workspace.
119+
See [download Xtext 2.1][xtext_download] for details.
120+
121+
The update site is: **`http://coffeescript-editor.eclipselabs.org.codespot.com/hg/`**
122+
So in Eclipse, perform these steps
123+
124+
- `Help -> Install New Software...`
125+
- `Add...`, then use this url as Location
126+
- `Work with...`, and choose the location you just added
127+
- Select `Coffeescript editor`
128+
- `Next` and `Finish`
129+
130+
You may be [given a warning](https://bitbucket.org/adamschmideg/coffeescript-eclipse/issue/6/),
131+
but that won't affect the plugin.
132+
133+
## Plans
134+
135+
### 0.4
136+
137+
- make grouping and error warning as optional and disable by default (Reason: there are a lot of tiny problem, false error detection.
138+
They are distracting developer.)
139+
140+
## Changelog
141+
142+
Check [devjournal.md](https://github.com/Nodeclipse/coffeescript-eclipse/blob/master/devjournal.md)
143+
144+
- 0.3.0 refresh release
145+
- switch to maven/tycho build
146+
- coffee icon
147+
148+
<dl>
149+
<dt>0.2.2</dt>
150+
<dd>Embed coffeescript in a DSL (see the `example` directory)</dd>
151+
<dt>Planned next release</dt>
152+
<dd>Integrated build: convert coffee code to javascript, and run it</dd>
153+
</dl>
154+
155+
## Building
156+
157+
### Maven build
158+
159+
[Maven](http://maven.apache.org/) build (using [Tycho plugin](http://eclipse.org/tycho/)) is headless build, that doesn't require Eclipse.
160+
161+
From base folder just run `mvn package`. Run offline when to re-build `mvn clean package -o`.
162+
163+
#### Install site.zip (quick and simple way)
164+
165+
1. Locate zip file under `org.nodeclipse.site\target` in Project Explorer, StartExplore-> Copy Resource Path to Clipboard
166+
2. Help -> Install New Software ...
167+
3. <kbd>Add...</kbd>
168+
4. <kbd>Archive...</kbd>
169+
5. Insert copied string into name and path.
170+
E.g. `C:\Users\pverest\git\nodeclipse-056\org.nodeclipse.site\target\org.nodeclipse.site-0.5.0-SNAPSHOT.zip`
171+
172+
For the next time just select the zip entry from Work With drop-down list.
173+
174+
#### Install from freshly built p2 repository (cool and long way)
175+
176+
1. `mvn package` or `mvn package -o` for re-build offline
124177
2. `npm install http-server -g`
125178
3. `http-server csep.site\target\repository -p 8010`
126179
4. // start http://localhost:8010/
@@ -140,28 +193,6 @@ If you want to contribute to the plugin, here's a quick overview how to setup an
140193
After these 5 steps, the project should build without errors and you can startup a new eclipse instance and open any .coffee file using the coffeescript editor.
141194

142195

143-
### Installation (old way 0.2.2)
144-
145-
There is [quick installer on Marketplace](http://marketplace.eclipse.org/content/coffeescript-editor-quick-installer).
146-
Below is original details instructions:
147-
148-
You will need an Eclipse instance with Xtext plugins.
149-
You can either install a complete Indigo distribution with Xtext,
150-
or install the required plugins into your existing workspace.
151-
See [download Xtext 2.1][xtext_download] for details.
152-
153-
The update site is: **`http://coffeescript-editor.eclipselabs.org.codespot.com/hg/`**
154-
So in Eclipse, perform these steps
155-
156-
- `Help -> Install New Software...`
157-
- `Add...`, then use this url as Location
158-
- `Work with...`, and choose the location you just added
159-
- Select `Coffeescript editor`
160-
- `Next` and `Finish`
161-
162-
You may be [given a warning](https://bitbucket.org/adamschmideg/coffeescript-eclipse/issue/6/),
163-
but that won't affect the plugin.
164-
165196
[coffeescript]: http://www.coffeescript.org
166197
[xtext]: http://www.xtext.org
167198
[xtext_download]: http://www.eclipse.org/Xtext/download.html

0 commit comments

Comments
 (0)