README.md in textbringer-0.1.6 vs README.md in textbringer-0.1.7

- old
+ new

@@ -1,14 +1,15 @@ # Textbringer [![Gem Version](https://badge.fury.io/rb/textbringer.svg)](https://badge.fury.io/rb/textbringer) +[![Dependency Status](https://gemnasium.com/shugo/textbringer.svg)](https://gemnasium.com/shugo/textbringer) [![Build Status](https://travis-ci.org/shugo/textbringer.svg?branch=master)](https://travis-ci.org/shugo/textbringer) [![Build status](https://ci.appveyor.com/api/projects/status/n20vtpfgcgii5jtc?svg=true)](https://ci.appveyor.com/project/shugo31737/textbringer) [![codecov](https://codecov.io/gh/shugo/textbringer/branch/master/graph/badge.svg)](https://codecov.io/gh/shugo/textbringer) -Textbringer is a member of a demon race that takes on the form of a text -editor. +Textbringer is a member of a demon race that takes on the form of an Emacs-like +text editor. ## Demo [![asciicast](https://asciinema.org/a/100156.png)](https://asciinema.org/a/100156) @@ -28,30 +29,63 @@ $ textbringer You can quit the editor by C-x C-c. -## Configuration of terminal emulators +## Configuration -### xterm +### Meta key +You need the following configuration of terminal emulators to use meta key. + +#### xterm + Add the following line to ~/.Xresources. XTerm*metaSendsEscape: true -### mlterm +#### mlterm Add the following lines to ~/.mlterm/main. mod_meta_key = alt mod_meta_mode = esc - col_size_of_width_a = 1 -### screen +### East asian ambiguous width +Add the following line to ~/.textbringer.rb to treat +[ambiguous characters](http://unicode.org/reports/tr11/#Ambiguous) +as fullwidth. + + CONFIG[:east_asian_ambiguous_width] = 2 + +You also need a LD_PRELOAD hack or a modified locale charmap because ncursesw +uses wcwidth(3). + +* https://github.com/fumiyas/wcwidth-cjk +* https://github.com/hamano/locale-eaw + +xterm, mlterm and screen have their own configuration options. + +#### xterm + +Add the following lines to ~/.Xresources. + + xterm*utf8: 1 + xterm*locale: true + xterm*cjkWidth: true + +#### mlterm + +Add the following line to ~/.mlterm/main. + + col_size_of_width_a = 2 + +#### screen + Add the following line to ~/.screenrc. - cjkwidth off + cjkwidth on ## Development After checking out the repo, run `bundle install` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.