[nongnu] elpa/inf-ruby c5d2178f17 072/265: Add a basic README

[ELPA Syncer]

branch: elpa/inf-ruby
commit c5d2178f17b3061c587bf02ccbb66faa9a1b40a0
Author: Bozhidar Batsov <bozhidar@tradeo.com>
Commit: Bozhidar Batsov <bozhidar@tradeo.com>

    Add a basic README
---
 README.md | 110 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 110 insertions(+)

diff --git a/README.md b/README.md
new file mode 100644
index 0000000000..d0164ec660
--- /dev/null
+++ b/README.md
@@ -0,0 +1,110 @@
+`inf-ruby.el` provides a REPL buffer connected to an IRB subprocess.
+
+## Installation
+
+### Via package.el
+
+`package.el` is the built-in package manager in Emacs 24+. On Emacs 23
+you will need to get [package.el](http://bit.ly/pkg-el23) yourself if you wish 
to use it.
+
+`inf-ruby` is available on both major `package.el` community
+maintained repos -
+[Marmalade](http://marmalade-repo.org/packages/inf-ruby) and
+[MELPA](http://melpa.milkbox.net).
+
+If you're not already using Marmalade, add this to your
+`~/.emacs.d/init.el` (or equivalent) and load it with <kbd>M-x 
eval-buffer</kbd>.
+
+```lisp
+(require 'package)
+(add-to-list 'package-archives
+             '("marmalade" . "http://marmalade-repo.org/packages/";))
+(package-initialize)
+```
+
+For MELPA the code you need to add is:
+
+```lisp
+(require 'package)
+(add-to-list 'package-archives
+             '("melpa" . "http://melpa.milkbox.net/packages/";) t)
+(package-initialize)
+```
+
+And then you can install `inf-ruby` with the following command:
+
+<kbd>M-x package-install [RET] inf-ruby [RET]</kbd>
+
+or by adding this bit of Emacs Lisp code to your Emacs initialization 
file(`.emacs` or `init.el`):
+
+```lisp
+(unless (package-installed-p 'inf-ruby)
+  (package-install 'inf-ruby))
+```
+
+If the installation doesn't work try refreshing the package list:
+
+<kbd>M-x package-refresh-contents [RET]</kbd>
+
+### Via el-get
+
+[el-get](https://github.com/dimitri/el-get) is another popular package manager 
for Emacs.
+If you're an el-get user just do <kbd>M-x el-get-install</kbd>.
+
+### Manual
+
+If you're installing manually, you'll need to:
+
+* drop the `inf-ruby.el` file somewhere on your load path (perhaps 
`~/.emacs.d/vendor`)
+* Add the following lines to your `.emacs` (or `init.el`) file:
+
+```lisp
+(autoload 'inf-ruby "inf-ruby" "Run an inferior Ruby process" t)
+(add-hook 'ruby-mode-hook 'inf-ruby-minor-mode)
+```
+
+Or, for [enh-ruby-mode](https://github.com/zenspider/enhanced-ruby-mode):
+
+```lisp
+(add-hook 'enh-ruby-mode-hook 'inf-ruby-minor-mode)
+```
+
+Installation via `package.el` interface does the above for you
+automatically.
+
+Additionally, consider adding
+
+```lisp
+(add-hook 'after-init-hook 'inf-ruby-switch-setup)
+```
+
+to your init file to easily switch from common Ruby compilation
+modes to interact with a debugger.
+
+### Emacs Prelude
+
+`inf-ruby` comes bundled in
+[Emacs Prelude](https://github.com/bbatsov/prelude). If you're a
+Prelude user you can start using it right away.
+
+## Usage
+
+You can fire up a REPL from everywhere with <kbd>M-x inf-ruby</kbd>.
+
+### Keymap
+
+Here's a list of the keybindings defined by `inf-ruby-minor-mode`.
+
+Keyboard shortcut                    | Command
+-------------------------------------|-------------------------------
+<kbd>C-M-x</kbd>                     | ruby-send-definition
+<kbd>C-x C-e</kbd>                   | ruby-send-last-sexp
+<kbd>C-c C-b</kbd>                   | ruby-send-block
+<kbd>C-c M-b</kbd>                   | ruby-send-block-and-go
+<kbd>C-c C-x</kbd>                   | ruby-send-definition
+<kbd>C-c M-x</kbd>                   | ruby-send-definition-and-go
+<kbd>C-c C-r</kbd>                   | ruby-send-region
+<kbd>C-c M-r</kbd>                   | ruby-send-region-and-go
+<kbd>C-c C-z</kdb>                   | ruby-switch-to-inf
+<kbd>C-c C-l</kbd>                   | ruby-load-file
+<kbd>C-c C-s</kbd>                   | inf-ruby