Commit Graph
50 Commits
Author SHA1 Message Date
Brian Mock 514eba0e4e Fixes #562 adds Windows demo setup help 2017-02-25 12:16:18 -08:00
Paris Kasidiaris e569b5669a Add coveralls badge 2017-02-22 16:22:50 +02:00
Bill Church e58a6975da Update README.md
Adding WebSSH2 to real-word uses
2017-02-01 16:41:47 -05:00
Vincent Woo e771483041 Add CoderPad to real world use cases
Hi everyone,

I'm very pleased to say I have cut CoderPad.io over to using xterm.js (replacing term.js). I've very pleased with the work you've done on it. You've implemented the many terrible hacks on top of term.js I had to write, except you've actually implemented stuff the right way.

I look forward to your continued progress on the project!

Cheers,
Vincent
2017-01-23 21:32:14 -08:00
Tyler Jewell 6c29ccfbd1 Add Codenvy to the list of xTerm supporters 2017-01-08 17:41:02 -08:00
Tyler Jewell 520f2bc9d6 Add additional products that use xTerm
Hi xTerm team. Over the past 6 months, we have been studying xTerm as a replacement for Eclipse Che's term.js. It's taken us a bit of an effort, but the work is now done!  You can expect that Eclipse Che engineers (abot 60 contributors) will make direct contributions back to xTerm ongoing now that we are fully integrated in. We integrate xTerm alongside GWT.  As we more natively integrate the solution, we'll make additional PRs directly back to the project.

As background on the research and integration work that we did, these are the postings from our engineering team's research from the past six months. Some of these issues have already been resolved, or in the process of being resolved.

We also plan a couple of blog posts to our forums (~250K followers) about xTerm integration later in Q1 after we make our 5.0.0 announcements. I could also add Codenvy to this PR as well since it has been released with the version based upon xTerm, but with Sourcelair being the initiators we didn't want to make it seem like we were trying to be competitive. This PR is about the promotion and success of xTerm, for which we are fully committed to.

## Xtermjs 
This document is result of investigation using xtemjs ui terminal instead of current term.js. It contains analyze pluses and minuses using xtermjs (release version 2.2.3) and technical problems.  Investigation issue: https://github.com/eclipse/che/issues/3210

## Description
For now we are using our own fork of the https://github.com/chjj/term.js for user interface websocket-terminal. But actually this project is no longer maintained. So we can not get new releases from this project and we need support this script on our own. Original project contains link for a maintained fork https://github.com/sourcelair/xterm.js. This fork uses MIT license and community intensive develops this project. It has such users like: Microsoft Visual Studio Code, SourceLair, ttyd. xterm.js had already done 46 releases https://github.com/sourcelair/xterm.js/releases.

## Technical Advantages of xTerm:
* xterm.js has js tests. We have not any test for old term.js.
* We can periodically update xtem.js by new release.
* Added parameter to cancel browser events.
* Default 256 colours moved from js to css.
* Added ability to set terminal theme.
* Improved resize mehanizm (added resize event).
* Added fit.ts script to fits terminal size to original height and width of parent div.
* Fixed lost text selection from current active line(when blink is enabled).
* Improved copy/paster mehanizm.
* Linkify URL feature.
* Implement moving back and forward across words with "Alt + ←" and "Alt + →" respectively.
* Improved special key handling.
* Added addons to exdens xterm.js
* Improved mehanizm copy/paster from clipboard.
* Fixed cross platform input problems(For IPad, Iphone, MacIntel, MacPPC and so on).
* Did some work to support UTF-8 symbols.
* Implemented scrollbar.
* Fixed incorrect mouse position for application with  pseudo-graphic user interface (for example Midnight Commander).
* Fix to prevent terminal scrolling when user is looking into scrollback(similar to gnome-terminal, if the user is scrolling up to look at past output and the currently running program adds output to the terminal, the viewport of xterm.js should not scroll and interrupt what they are looking at.)
* Make right-click work on all browsers.

##  Broken Changes: 
We can move on our changes to realize copy/paste by hotkeys Ctrl + C/Ctrl +V. But xterm.js support hotkeys more common for terminal: Ctrl + Insert and Shift + Insert and maybe that's enough.

Drop support for old mouse wheel APIs: all browsers have supported the WheelEvent (onwheel) for sometime now, since Firefox does not support onmousewheel which is also non-standard but works with the standard interface, it makes sense to drop support now.

## Browser Support
Since xterm.js is typically implemented as a developer tool, only modern browsers are supported officially. Here is a list of the versions to support:
Chrome 48+
Edge 13+
Firefox 44+
Internet Explorer 11+
Opera 35+
Safari 8+

Xterm.js works seamlessly in Electron apps and may even work on earlier versions of the browsers but these are the browsers xterm.js developers strive to keep working.

## Known major bugs:
https://github.com/sourcelair/xterm.js/issues/307
https://github.com/sourcelair/xterm.js/issues/362
https://github.com/sourcelair/xterm.js/issues/348
https://github.com/sourcelair/xterm.js/issues/325 Data loss when resizing terminal (but this bug is exist in the current terminal ui in the CHE too). Community has pull request to fix this issue for xtermjs https://github.com/sourcelair/xterm.js/pull/404 .
 
Additional information: 

Code base xterm.js consist of files written on native javascript and typescript. For manage js dependency and configuration used npm, typings, bower and node. Development tendency: rewrite xtemr.js completely on the Typescript(information about this included to the release notes 2.2.3).
2017-01-08 09:44:14 -08:00
Ben Hall cd44fe7bcd Katacoda xterm.js integration is live 2016-12-22 20:10:33 +00:00
Ben Hall bb3d6ee72c Katacoda xterm.js integration is live 2016-12-22 12:01:44 +00:00
Saswat Das d018a547a2 Update README.md
Added Getting started content from the xtermjs.org website
2016-12-18 04:48:19 +05:30
Saswat Das 4ee1e00808 Update README.md
Adding a getting started instruction for adding xterm to a parent div and listening for data output from xterm
2016-12-15 21:26:04 +05:30
Paris Kasidiaris c9eaae6bd5 Update path to addons in README.md 2016-12-06 10:55:40 +02:00
Daniel Imms 5cbc2f0ea5 Add link to TravisCI badge 2016-11-28 10:46:19 -08:00
Daniel Imms 771642d17d Make ttyd link bold like the others 2016-11-09 19:34:36 -08:00
Shuanglei Tao 12840dae6c Add ttyd to the real-world uses section of README 2016-11-09 20:23:36 +08:00
Anton Yurovskykh c2fccc0350 Update README.md
Fix typo: is => if
2016-09-02 09:28:57 +03:00
Paris Kasidiaris c46e799dd0 Update README.md to include xterm.js from new directory 2016-08-29 22:57:19 +03:00
Daniel Imms 68b012ca06 Improve grammar 2016-08-25 14:46:20 -07:00
Paris Kasidiaris e5656b9982 Add "Chat on Gitter" badge 2016-08-22 14:40:34 +03:00
Paris 0a74b9aa3b Fix typos 2016-08-04 13:00:47 +03:00
Paris 7e90576391 Update README and remove screenshot 2016-08-04 12:01:37 +03:00
Paris 7cd99d1559 Add Development and Contribution section in README.md 2016-07-17 22:04:48 +03:00
Paris Kasidiaris 466dca361c Merge pull request #187 from Tyriar/remove_linkify_from_readme
Switch linkify for fit in readme
2016-07-17 21:46:19 +03:00
Daniel Imms 9dd64dfb49 Switch linkify for fit in readme
Linkify doesn't work currently so it shouldn't be used as an example.
2016-07-15 16:41:40 -07:00
Daniel Imms 2c810ce763 Add note about support intentions 2016-07-15 10:12:55 -07:00
Daniel Imms b61e81d5b4 Add latest Edge version as supported, alphabetize 2016-07-15 10:10:10 -07:00
Daniel Imms f3db84decb Add statement on browser support
Fixes #183
2016-07-13 15:28:14 -07:00
Daniel Imms 15cf76c767 Bind to 127.0.0.1 on Windows only 2016-06-22 20:43:41 -07:00
Daniel Imms 623853f3f4 Get demo working on Windows
- Removed bin bash scripts in favor of npm scripts so they work
  cross-platform
- Moved to use 127.0.0.1 as 0.0.0.0 doesn't work on Windows

Note that this doesn't work with the current pty.js as it doesn't build on
Windows.
2016-06-13 15:55:47 -07:00
Paris ab1526b085 Add travis ci build status in xterm.js 2016-06-09 10:10:36 +03:00
Daniel Imms 2a36ff0839 Merge remote-tracking branch 'upstream/master' into patch-2 2016-06-07 23:34:35 -07:00
Daniel Imms dab80b58ae Add section on addons to README 2016-06-07 22:31:39 -07:00
Daniel Imms 289ff8092d Add demo section to README
Fixes #87
2016-06-07 17:08:37 -07:00
Paris dd93e62a41 Update README 2016-02-09 14:48:54 +02:00
Paris d6c8369630 Update README.md 2015-04-13 19:21:47 +03:00
paris 391d8f4097 Bump version to 0.29 and copyright year to 2015 2015-01-19 19:07:28 +02:00
paris d24e00554d Tiny README updates 2014-09-10 11:15:24 +00:00
Paris Kasidiaris 3d40dcf3c5 Update company name 2014-08-18 11:00:49 +03:00
paris 561fc59dbc Added screenshot for docs
Bumped version to 0.12
2014-05-03 00:30:04 +00:00
paris dfa45739e4 Removed tag 2014-03-24 18:12:02 +00:00
paris 06e24b6fe2 Updated license in README.md 2014-03-24 16:15:02 +00:00
paris b621669af4 Updated LICENSE and REAMDE
Also removed useless files.
2014-03-24 16:11:27 +00:00
Christopher Jeffrey 0e8a2c3704 fix CLA. 2013-12-04 06:38:02 -06:00
Christopher Jeffrey 8ac7a6eb0b add CLA to readme. 2013-12-04 06:31:08 -06:00
Christopher Jeffrey 7484893695 options. events. readme. 2013-08-16 20:13:32 -05:00
Christopher Jeffrey 628af0532f deal with bad csr's. improve example. readme. 2013-08-10 15:39:28 -05:00
Christopher Jeffrey 86922c7c8b readme. misc. 2013-08-10 11:18:07 -05:00
Christopher Jeffrey 1bb83a207d readme. package.json. 2013-08-08 11:00:11 -05:00
Christopher Jeffrey 14248234d4 v0.0.1 2013-08-08 09:27:30 -05:00
Christopher Jeffrey 9127316158 make term.js more portable. 2013-08-08 09:06:06 -05:00
Christopher Jeffrey 51946a73c8 up 2013-08-08 09:03:31 -05:00