# Textbringer

[![Gem Version](https://badge.fury.io/rb/textbringer.svg)](https://badge.fury.io/rb/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)

Textbringer is a member of a demon race that takes on the form of a text
editor.

## Demo

[![asciicast](https://asciinema.org/a/100156.png)](https://asciinema.org/a/100156)

## WARNING

Textbringer is beta software, and you may lose your text.  Unsaved buffers will
be dumped in ~/.textbringer/buffer_dump on crash.

APIs are undocumented and unstable.  There is no compatibility even in the same
minor versions.

## Installation

    $ gem install textbringer

## Usage

    $ textbringer

You can quit the editor by C-x C-c.

## Configuration of terminal emulators

### xterm

Add the following line to ~/.Xresources.

    XTerm*metaSendsEscape: true

### mlterm

Add the following lines to ~/.mlterm/main.

    mod_meta_key = alt
    mod_meta_mode = esc
    col_size_of_width_a = 1

### screen

Add the following line to ~/.screenrc.

    cjkwidth off

## 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.

To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).

## Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/shugo/textbringer.


## License

The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).