Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 151 lines (93 sloc) 6.904 kb
e20418e Mike de Boer updated README
mikedeboer authored
1 # Cloud9 IDE
c00d34a Matt Pardee removed the "test" line
mattpardee authored
2
6a9dd77 Fabian Jakobs Edited README.md via GitHub
fjakobs authored
3 The Cloud9 IDE is an open source project started by [ajax.org], built on top of [Node.JS].
e20418e Mike de Boer updated README
mikedeboer authored
4
c414b0c Ruben Daniels * Tweaks
javruben authored
5 This Integrated Development Environment aims to bring all great features from other existing IDE's and source code editors like Eclipse, Netbeans, Textmate, and many others together, bundled as plugins.
6 Cloud9's main focus is on Javascript development, it is able to set a new standard for client and server development integration.
e20418e Mike de Boer updated README
mikedeboer authored
7
8 And if you find that functionality is missing? Just write a plugin and patch it yourself!
9
10 Written in Javascript, for Javascripters.
11
12 ## Features
13
14 * High performance text editor with bundled syntax highlighting support for JS, HTML, CSS and mixed modes.
15 * Integrated debugger for [Node.JS] applications which can started, paused and stopped from within the IDE
c414b0c Ruben Daniels * Tweaks
javruben authored
16 * Integrated debugger for the Google Chrome browser which can started, paused and stopped from within the IDE
e20418e Mike de Boer updated README
mikedeboer authored
17 * Local filesystem is exposed through [WebDAV](http://en.wikipedia.org/wiki/WebDAV) to the IDE, which makes it possible to connect to remote workspaces as well
18 * Highly extensible through the plugin system
19 * Bundled plugins: browser, clipboard, code (editor), console, debugger, docs, editors, filesystem, html, keybindings, newresource, noderunner, panels, refactor, richtext, save, searchreplace, settings, tree, undo
20
db49139 Ruben Daniels * Tweaked the readme
javruben authored
21 ## Browser Support
cf05a4b Ruben Daniels Small change in readme.
javruben authored
22 We are developing on firefox and chrome and this is a development repo, other browsers might be less stable until a proper release.
db49139 Ruben Daniels * Tweaked the readme
javruben authored
23
e20418e Mike de Boer updated README
mikedeboer authored
24 ## Usage
25
26 After a Git checkout of the project or download (see Installation section), the command you need to run the IDE locally is the following:
27
8fb9e16 rikarends readme
rikarends authored
28 To start cloud9 and install all submodules you can use the quickstart options for your platform on the console or from your explorer/finder and opens it in your default browser:
29
7074488 Fabian Jakobs merge linux and osx startup scripts
fjakobs authored
30 Linux and OSX:
31
d6de249 Fabian Jakobs update package json
fjakobs authored
32 $ bin/cloud9.sh
7074488 Fabian Jakobs merge linux and osx startup scripts
fjakobs authored
33
34 Windows:
35
eed5c5c Ruben Daniels merged
javruben authored
36 > bin\cloud9-win32.bat
8fb9e16 rikarends readme
rikarends authored
37
0f48214 Ruben Daniels * Improved version notice a bit
javruben authored
38 Note you'll need a git version 1.7 or higher to use the stock shell script provided.
35e8ee0 adding note for git version requirement
Michael Kimsal authored
39
8fb9e16 rikarends readme
rikarends authored
40 If you want to start it manually try:
41
e20418e Mike de Boer updated README
mikedeboer authored
42 $ node bin/cloud9.js
43
44 This runs the IDE with itself set as the workspace. When you open the url
45
46 http://localhost:3000
47
48 in your browser, it will show the directory structure of the current workspace in a tree. Since none is provided by the startup command above, it will show the IDE directory contents as a default workspace.
49
50 You can specify your own workspace as follows:
51
52 $ node bin/cloud9.js -w /path/to/your/awesome/workspace
ff079c7 Ruben Daniels Updated Readme
javruben authored
53
52ab85a Ruben Daniels update readme
javruben authored
54 And as a result the tree will display the contents of that directory.
55
ff079c7 Ruben Daniels Updated Readme
javruben authored
56 You can specify the ip cloud9 is listening to using:
57
58 $ node bin/cloud9.js -l 192.168.2.1
59
52ab85a Ruben Daniels update readme
javruben authored
60 Or specify to listen to all ip's
ff079c7 Ruben Daniels Updated Readme
javruben authored
61
62 $ node bin/cloud9.js -l all
52ab85a Ruben Daniels update readme
javruben authored
63
64 To see more usage information and additional command line options use.
e20418e Mike de Boer updated README
mikedeboer authored
65
66 $ node bin/cloud9.js -h
67
68 ## Installation
69
70 Via git (or downloaded tarball):
71
72 $ git clone git://github.com/ajaxorg/cloud9.git
73
74 Via [npm](http://github.com/isaacs/npm):
75
76 $ npm install cloud9
77
ae9d44c rikarends * building your own binaries
rikarends authored
78 ## Startup errors: Binaries and node.js
79
80 Starting Cloud9 using cloud9.sh or .bat uses nodejs and node-o3-xml binaries that are distributed with Cloud9.
81 We have included binaries for OSX 64 bit Intel (10.5/10.6), 32 and 64 bit Ubuntu and Windows 32 bit.
82 All binaries are based on node 0.2.x latest stable.
83 If you get an error about unable to load o3-xml or an architecture error, you will need to compile nodejs and node-o3-xml yourself and put it in the right directory of cloud9. For information how to compile node, please check www.nodejs.org. You will need to compile and install nodejs before you can compile node-o3-xml.
84
85 $ git clone http://github.com/ajaxorg/o3
86 $ cd o3
87 $ ./tools/node_modules_build
d7b0133 Matt Pardee Fixed o3 directory. Thanks misfo!
mattpardee authored
88 $ cp build/default/o3.node cloud9dir/support/jsdav/support/node-o3-xml-v4/lib/o3-xml/
ae9d44c rikarends * building your own binaries
rikarends authored
89
c9d0bb7 rikarends * readme typo
rikarends authored
90 after this you can start cloud9 manually using node bin/cloud9.js
ae9d44c rikarends * building your own binaries
rikarends authored
91
e91b299 Fabian Jakobs proper dispose if ide plugins
fjakobs authored
92 ## How to compile a custom node.js binary
93
94 There is a known V8 bug in the 0.2.x banch of node, which prevents the debugger from working under Linux. To work around this bug the node binary has to be compiled with gcc 4.4:
95
96 $ export GCC_VERSION=44
97 $ configure
98 $ make
99
e20418e Mike de Boer updated README
mikedeboer authored
100 ## Documentation
101
102 Documentation is in the making.
103
104 ## Open Source Projects Used
105
106 The Cloud9 IDE couldn't be this cool if it weren't for the wildly productive [Node.JS] community producing so many high quality software.
107 Main projects that we use as building blocks:
108
109 * [async.js] by [fjakobs]
110 * [jsDAV] by [mikedeboer]
111 * [connect] by [senchalabs](http://github,com/senchalabs)
112 * [socket.io] by [LearnBoost](http://github.com/LearnBoost)
8a1ce8a Ruben Daniels Change link to ace in readme
javruben authored
113 * [ace](http://github.com/ajaxorg/ace) by [fjakobs]
c533c3d Mike de Boer updated README
mikedeboer authored
114 * [apf](http://www.ajax.org) by [ajax.org]
e20418e Mike de Boer updated README
mikedeboer authored
115 * and of course [Node.JS]!
116
117 Thanks to all developers and contributors of these projects!
118
119 [fjakobs]: http://github.com/fjakobs
120 [javruben]: http://github.com/javruben
121 [mikedeboer]: http://github.com/mikedeboer
c533c3d Mike de Boer updated README
mikedeboer authored
122 [ajax.org]: http://www.ajax.org/
e20418e Mike de Boer updated README
mikedeboer authored
123 [async.js]: http://github.com/fjakobs/async.js
124 [jsDAV]: http://github.com/mikedeboer/jsdav
125 [connect]: http://github.com/senchalabs/connect
126 [socket.io]: http://github.com/LearnBoost/Socket.IO-node.git
bed4ab3 Fabian Jakobs add requireJS to the list of used open source projects
fjakobs authored
127 [requireJS]: http://requirejs.org/
e20418e Mike de Boer updated README
mikedeboer authored
128 [Node.JS]: http://nodejs.org/
129
130 ## License
131
35e8ee0 adding note for git version requirement
Michael Kimsal authored
132 The GPL version 3, read it at [http://www.gnu.org/licenses/gpl.txt](http://www.gnu.org/licenses/gpl.txt)
e6c4fbf Matt Pardee CLA copy in readme and PDFs in doc folder
mattpardee authored
133
134 ##Contributing
135
136 Cloud9 wouldn't be where it is now without contributions. Feel free to fork and improve/enhance Cloud9 in any way your want. If you feel that the Cloud9 community will benefit from your changes, please open a pull request. To protect the interests of the Cloud9 contributors and users we require contributors to sign a Contributors License Agreement (CLA) before we pull the changes into the main repository. Our CLA is the simplest of agreements, requiring that the contributions you make to an ajax.org project are only those you're allowed to make. This helps us significantly reduce future legal risk for everyone involved. It is easy, helps everyone, takes ten minutes, and only needs to be completed once. There are two versions of the agreement:
137
138 1. [The Individual CLA](https://github.com/ajaxorg/cloud9/raw/master/doc/Contributor_License_Agreement-v2.pdf): use this version if you're working on an ajax.org project in your spare time, or can clearly claim ownership of copyright in what you'll be submitting.
139 2. [The Corporate CLA](https://github.com/ajaxorg/cloud9/raw/master/doc/Corporate_Contributor_License_Agreement-v2.pdf): have your corporate lawyer review and submit this if your company is going to be contributing to ajax.org projects
140
141 If you want to contribute to an ajax.org project please print the CLA and fill it out and sign it. Then either send it by snail mail or fax us or send it back scanned (or as a photo) by email.
142
143 Email: info@ajax.org
144
145 Fax: +31 (0) 206388953
146
147 Address: Ajax.org B.V.
148 Keizersgracht 241
149 1016 EA, Amsterdam
150 the Netherlands
Something went wrong with that request. Please try again.