Skip to content

Commit

Permalink
Polish development and contribution section
Browse files Browse the repository at this point in the history
  • Loading branch information
Tyriar authored Mar 14, 2017
1 parent ff29fd6 commit 8cf76cc
Showing 1 changed file with 1 addition and 21 deletions.
22 changes: 1 addition & 21 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -121,27 +121,7 @@ The existing releases are available at this GitHub repo's [Releases](https://git

Xterm.js is maintained by [SourceLair](https://www.sourcelair.com/) and a few external contributors, but we would love to receive contributions from everyone!

To contribute either code, documentation or issues to xterm.js please read the [Contributing document](CONTRIBUTING.md) before.

The development of xterm.js does not require any special tool. All you need is an editor that supports JavaScript and a browser (if you would like to run the demo you will need Node.js to get all features).

It is recommended though to use a development tool that uses xterm.js internally, to develop for xterm.js. [Eating our own dogfood](https://en.wikipedia.org/wiki/Eating_your_own_dog_food) has been proved extremely beneficial for this project. Known tools that use xterm.js internally are:

#### [SourceLair](https://www.sourcelair.com)

Visit https://lair.io/sourcelair/xterm and follow the instructions. All development will happen in your browser.

#### [Visual Studio Code](http://code.visualstudio.com/)

[Download Visual Studio Code](http://code.visualstudio.com/Download), clone xterm.js and you are all set.

#### [Eclipse Che](http://www.eclipse.org/che)

You can start Eclipse Che with `docker run eclipse/che start`.

#### [Codenvy](http://www.codenvy.io)

You can create a trial account or install an enterprise version with `docker run codenvy/cli start`.
To contribute either code, documentation or issues to xterm.js please read the [Contributing document](CONTRIBUTING.md) beforehand. The development of xterm.js does not require any special tool. All you need is an editor that supports JavaScript/TypeScript and a browser. You will need Node.js installed locally to get all the features working in the demo.

## License Agreement

Expand Down

0 comments on commit 8cf76cc

Please sign in to comment.