Skip to content
This repository has been archived by the owner on Jul 18, 2020. It is now read-only.

Commit

Permalink
Add readme.
Browse files Browse the repository at this point in the history
  • Loading branch information
technomancy committed Jan 5, 2012
1 parent bc36f7a commit e91af77
Show file tree
Hide file tree
Showing 2 changed files with 51 additions and 0 deletions.
50 changes: 50 additions & 0 deletions README.md
@@ -0,0 +1,50 @@
# rcirc ucomplete

Unambiguous completion for rcirc.

If you don't like the cycling completion that is the default in rcirc,
try this instead.

## Installation

Install from [Marmalade](http://marmalade-repo.org) using package.el
if you have Emacs 24 or newer. If you aren't set up to install from
Marmalade, try this:

```lisp
(require 'package)
(add-to-list 'package-archives
'("marmalade" . "http://marmalade-repo.org/packages/"))
(package-initialize)
```

Eval the above code, run `M-x package-refresh-contents`, and then do
`M-x package-install rcirc-ucomplete` to install.

Alternatively to do a manual install, place `rcirc-ucomplete.el` on
the classpath and add this to your Emacs config:

```lisp
(autoload rcirc-ucomplete "rcirc-ucomplete" "" t)
(eval-after-load 'rcirc
'(define-key rcirc-mode-map (kbd "TAB") 'rcirc-ucomplete))
```

## License

Copyright © 2007, 2011 Phil Hagelberg

This program is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License as
published by the Free Software Foundation; either version 3 of
the License, or (at your option) any later version.

This program is distributed in the hope that it will be
useful, but WITHOUT ANY WARRANTY; without even the implied
warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public
License along with this program; if not, write to the Free
Software Foundation, Inc., 59 Temple Place, Suite 330, Boston,
MA 02111-1307 USA
1 change: 1 addition & 0 deletions rcirc-ucomplete.el
Expand Up @@ -5,6 +5,7 @@
;; Author: Phil Hagelberg <technomancy@gmail.com>
;; Version: 1.0.1
;; Keywords: rcirc, irc
;; URL: https://github.com/technomancy/rcirc-ucomplete

;; This file is NOT part of GNU Emacs.

Expand Down

0 comments on commit e91af77

Please sign in to comment.