_____ _ _ _
| ____|_ __ ___ __ _ ___ ___ | | | | ___| |_ __ ___
| _| | '_ ` _ \ / _` |/ __/ __| | |_| |/ _ \ | '_ ` _ \
| |___| | | | | | (_| | (__\__ \ | _ | __/ | | | | | |
|_____|_| |_| |_|\__,_|\___|___/ |_| |_|\___|_|_| |_| |_|
Helm
is incremental completion and selection narrowing framework for
Emacs. It will help steer you in the right direction when you're looking
for stuff in Emacs (like buffers, files, etc).
Helm is a fork of anything.el
and can be considered to be its
successor. Helm
sets out to clean up the legacy code in anything.el
and provide a cleaner, leaner and more modular tool, that's not tied in
the trap of backward compatibility.
- Clone the
helm
repository to some directory:
```elisp
$ git clone https://github.com/emacs-helm/helm.git /path/to/helm/directory
```
- Run make from this directory.
- Add to
.emacs.el
(or equivalent):
```elisp
(add-to-list 'load-path "/path/to/helm/directory")
(require 'helm-config)
```
- Clone the
helm
repository to some directory:
```elisp
$ git clone https://github.com/emacs-helm/helm.git /path/to/helm/directory
```
-
Put following files somewhere in your
load-path
:helm.el
helm-config.el
helm-match-plugin.el
-
Byte-compile these files.
-
Add this code to
.emacs.el
:
(require 'helm-config)
Note to Linux Distribution (e.g. Debian) Maintainers
Use only the files mentioned above in the **Manual install** section for your packages, other files found on emacswiki or elsewhere are not supported.
If you're afraid to play with Emacs's configuration, but want to try out Helm - have to fear. Have a look at Emacs Prelude - it has Helm built-in and properly set-up.
Just type M-x helm-mini
and enjoy. You might want to bind that command to
a keyboard shortcut. Here's a suggestion:
(global-set-key (kbd "C-c h") 'helm-mini)
As a startup point you can also look at the helm section in Emacs menu to discover some of the commands provided by helm.
Helm is capable of a lot. For now you can find all the gory details only in the pdf manual. Soon we'll provide supplementary documentation.
Check out the project's issue list a list of unresolved issues. By the way - feel free to fix any of them and sent us a pull request. :-)
Here's a list of all the people who have contributed to the development of Helm.
Bug reports and suggestions for improvements are always welcome. GitHub pull requests are even better! :-)
Cheers,
The Helm Team