embarklabs
/
neo-blessed
mirror of https://github.com/embarklabs/neo-blessed.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity

revert readme.

This commit is contained in:
Christopher Jeffrey 2015-07-19 05:14:41 -07:00
parent 415b35e7ee
commit 211fcd3b4c
1 changed files with 7 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
README.md
View File

@ -2212,30 +2212,25 @@ Examples can be found in `examples/`.
- All ACS vertical lines look this way in iTerm2 with the default font. - All ACS vertical lines look this way in iTerm2 with the default font.
3. Why can't I use my mouse in Terminal.app? 3. Why can't I use my mouse in Terminal.app?
- Terminal.app does not support mouse events. - Terminal.app does not support mouse events.
4. Why aren't all mouse events working in my terminal+tmux? 4. Why doesn't the OverlayImage element appear in my terminal?
- If you are using tmux >=2.0, "all motion" mouse events are [no longer
supported][allmotion], and likely will never be supported again. There is
no workaround for this. Don't rely heavily on hover effects for your
application to function if you want it to work in tmux..
5. Why doesn't the OverlayImage element appear in my terminal?
- The OverlayImage element uses w3m to display images. This generally only - The OverlayImage element uses w3m to display images. This generally only
works on X11+xterm/urxvt, but it _may_ work on other unix terminals. works on X11+xterm/urxvt, but it _may_ work on other unix terminals.
6. Why can't my mouse clicks register beyond 255 cells? 5. Why can't my mouse clicks register beyond 255 cells?
- Older versions of VTE do not support any modern mouse protocol. On top of - Older versions of VTE do not support any modern mouse protocol. On top of
that, the old X10 protocol it _does_ implement is bugged. Through several that, the old X10 protocol it _does_ implement is bugged. Through several
workarounds we've managed to get the cell limit from `127` to `255`. If workarounds we've managed to get the cell limit from `127` to `255`. If
you're not happy with this, you may want to look into using xterm or urxvt, you're not happy with this, you may want to look into using xterm or urxvt,
or a terminal which uses a modern VTE, like gnome-terminal. or a terminal which uses a modern VTE, like gnome-terminal.
7. Is blessed efficient? 6. Is blessed efficient?
- Yes. Blessed implements CSR and uses the painter's algorithm to render the - Yes. Blessed implements CSR and uses the painter's algorithm to render the
screen. It maintains two screen buffers so it only needs to render what screen. It maintains two screen buffers so it only needs to render what
has changed on the terminal screen. has changed on the terminal screen.
8. Will blessed work with all terminals? 7. Will blessed work with all terminals?
- Yes. Blessed has a terminfo/termcap parser and compiler that was written - Yes. Blessed has a terminfo/termcap parser and compiler that was written
from scratch. It should work with every terminal as long as a terminfo from scratch. It should work with every terminal as long as a terminfo
file is provided. If you notice any compatibility issues in your termial, file is provided. If you notice any compatibility issues in your termial,
do not hesitate to post an issue. do not hesitate to post an issue.
9. What is "curses" and "ncurses"? 8. What is "curses" and "ncurses"?
- ["curses"][curses] was an old library written in the early days of unix - ["curses"][curses] was an old library written in the early days of unix
which allowed a programmer to easily manipulate the cursor in order to which allowed a programmer to easily manipulate the cursor in order to
render the screen. ["ncurses"][ncurses] is a free reimplementation of render the screen. ["ncurses"][ncurses] is a free reimplementation of
@ -2243,12 +2238,12 @@ Examples can be found in `examples/`.
compatibility and is now the standard library for implementing terminal compatibility and is now the standard library for implementing terminal
programs. Blessed uses neither of these, and instead handles terminal programs. Blessed uses neither of these, and instead handles terminal
compatibility itself. compatibility itself.
10. What is the difference between blessed and blessed-contrib? 9. What is the difference between blessed and blessed-contrib?
- blessed is a major piece of code which reimplements curses from the ground - blessed is a major piece of code which reimplements curses from the ground
up. A UI API is then layered on top of this. [blessed-contrib][contrib] is up. A UI API is then layered on top of this. [blessed-contrib][contrib] is
a popular library built on top of blessed which makes clever use of modules a popular library built on top of blessed which makes clever use of modules
to implement useful widgets like graphs, ascii art, and so on. to implement useful widgets like graphs, ascii art, and so on.
11. Are there blessed-like solutions for non-javascript platforms? 10. Are there blessed-like solutions for non-javascript platforms?
- Yes. There are some fantastic solutions out there. - Yes. There are some fantastic solutions out there.
- Perl: [Curses::UI][curses-ui] - Perl: [Curses::UI][curses-ui]
- Python: [Urwid][urwid] - Python: [Urwid][urwid]
@ -2277,4 +2272,3 @@ See LICENSE for more info.
[curses-ui]: http://search.cpan.org/~mdxi/Curses-UI-0.9609/lib/Curses/UI.pm [curses-ui]: http://search.cpan.org/~mdxi/Curses-UI-0.9609/lib/Curses/UI.pm
[termbox]: https://github.com/nsf/termbox-go [termbox]: https://github.com/nsf/termbox-go
[ttystudio]: https://github.com/chjj/ttystudio#choosing-a-new-font-for-your-terminal-recording [ttystudio]: https://github.com/chjj/ttystudio#choosing-a-new-font-for-your-terminal-recording
[allmotion]: https://github.com/tmux/tmux/issues/55