Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README and remove screenshot #219

Merged
merged 2 commits into from
Aug 4, 2016
Merged

Update README and remove screenshot #219

merged 2 commits into from
Aug 4, 2016

Conversation

parisk
Copy link
Contributor

@parisk parisk commented Aug 4, 2016

Update README to add more information about what xterm.js is, what are its use cases and who maintains it.

Also removed the screenshot, as it might be more confusing than helpful.

Closes #198.

@vincentwoo
Copy link
Contributor

good start! long term I think there really should be docs on how xterm works in practice (how does it handle line wrapping? can you use css word-wrap or does it need to be literally the same number of rows/cols as the backend terminal?) but getting the ball rolling is great

couple typos:

It enables applications to provide fully featured terminals to their users and create great development experiences.

Modular, event-based API: Let's (no apostrophe) you build addons and themes with ease

@parisk
Copy link
Contributor Author

parisk commented Aug 4, 2016

Thanks for the comments @vincentwoo! I fixed the typos.

You can find the API reference at http://docs.xtermjs.org.

Also we have started a repo for the website but no work has been done there yet: https://github.com/xtermjs/xtermjs.org. Hopefully I will get on top of this within the next couple of weeks.

@parisk parisk merged commit 3117fe9 into master Aug 4, 2016
@vincentwoo
Copy link
Contributor

I didn't know about the docs, but I don't think it constitutes a "real" API reference. It's mostly one-sentence descriptions of various functions supported by xterm. I believe most of the doc content is basically old WIP commentary left by @chjj when he wrote the original term.js. It's not clear what changes you've made since, and thus the docsite feels very untrustworthy.

A "real" reference would explain the internal model of xterm, its corner cases, and how you might achieve certain usecases, etc.

@Tyriar Tyriar deleted the issue/198 branch October 31, 2016 19:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants