diff options
author | Sean Whitton <spwhitton@spwhitton.name> | 2016-01-08 14:48:08 -0700 |
---|---|---|
committer | Sean Whitton <spwhitton@spwhitton.name> | 2016-10-08 18:45:05 -0700 |
commit | be89b2ef8134f33fd7e7c90b3d15e4da852aa948 (patch) | |
tree | a5835962ada8fa6ff0feceaadc83c4e1cdeb99a8 | |
parent | 211eeb1dac5920e6c1185c628fca7a9e0a1b2521 (diff) |
decruft-README
Gbp-Pq: Name 0003-decruft-README.patch
-rw-r--r-- | README.md | 126 |
1 files changed, 13 insertions, 113 deletions
@@ -1,17 +1,8 @@ -<p><a href="http://www.gnu.org/licenses/gpl-3.0.txt"><img src="https://img.shields.io/badge/license-GPL_3-green.svg" alt="License GPL 3" /></a> -<a href="https://melpa.org/#/helm"><img alt="MELPA" src="https://melpa.org/packages/helm-badge.svg"/></a> -<a href="https://stable.melpa.org/#/helm"><img alt="MELPA Stable" src="https://stable.melpa.org/packages/helm-badge.svg"/></a></p> +Maintainance of Helm is a lot of work that I do freely on my sparse +time, please consider donating: +<https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=thierry.volpiatto@gmail.com&lc=US&currency_code=EUR&bn=PP-DonationsBF:btn_donateCC_LG.gif:NonHosted> +or or <https://gratipay.com/emacs-helm/> -<h1>Emacs-helm</h1> - -<p><img src="https://avatars3.githubusercontent.com/u/1541688?v=3&s=200" alt="Emacs-helm" title="" /></p> - -<p>Maintainance of Helm is a lot of work that I do freely on my sparse time,</p> -<p>please <a href="https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=thierry.volpiatto@gmail.com&lc=US&currency_code=EUR&bn=PP-DonationsBF:btn_donateCC_LG.gif:NonHosted"><img src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" alt="Donate" title="" /></a> to help this project, </p> -or [![Support via Gratipay](https://cdn.rawgit.com/gratipay/gratipay-badge/2.3.0/dist/gratipay.png)](https://gratipay.com/emacs-helm/) - - -<!-- markdown-toc start - Don't edit this section. Run M-x markdown-toc-generate-toc again --> **Table of Contents** - [Introduction](#introduction) @@ -34,8 +25,6 @@ or [![Support via Gratipay](https://cdn.rawgit.com/gratipay/gratipay-badge/2.3.0 - [Bugs & Improvements](#bugs--improvements) - [Getting help](#getting-help) -<!-- markdown-toc end --> - # Introduction `Helm` is an Emacs framework for incremental completions and narrowing @@ -61,98 +50,11 @@ and dired operations in Helm. # Getting Started -## Quick install from git - - 1. Clone the `helm` repository to some directory: - - ```elisp - $ git clone https://github.com/emacs-helm/helm.git /path/to/helm/directory - ``` - - 2. Clone the `async` repository to some directory (facultative) - - ```elisp - $ git clone https://github.com/jwiegley/emacs-async.git /path/to/async/directory - ``` - 3. Run `make` from the `helm` directory. - - 3. Add to `.emacs.el` (or equivalent): - - ```elisp - ;; If async is installed - (add-to-list 'load-path "/path/to/async/directory") - - (add-to-list 'load-path "/path/to/helm/directory") - (require 'helm-config) - ``` - -_NOTE:_ Installing helm using git and make is the safest way. - -To quickly run `helm`, launch this script from helm directory: - -`./emacs-helm.sh` - -Also use the same script above for bug reporting. - -_NOTE:_ This script does not work on Windows systems. - -## Install from Emacs packaging system - -Helm can also be installed from MELPA repository at http://melpa.org/. -You will find the instructions to install packages from MELPA [here](https://github.com/melpa/melpa#usage). - -No further configuration is necessary to run helm other than perhaps a -one-line entry in the Emacs init file: - -```elisp -(require 'helm-config) -``` - -_WARNING:_ Helm upgrades from MELPA repository encountered errors -because of the way package.el fetched and compiled updates for -existing packages. To get around these errors, Helm adds -[Async](https://github.com/jwiegley/emacs-async) as a dependency -package install. Async forces compilation in a clean environment, -which solves those compilation errors. Since async has other benefits -as well, both for Helm and other packages, we recommend installing -async even for Helm installs using git. See -[FAQ](https://github.com/emacs-helm/helm/wiki#faq) for details. - -_Note:_ Restart Emacs for Helm updates from MELPA repositories to take -effect. - -**Note to Linux Distributions Maintainers** - -`Only the extensions in the github emacs-helm repository are supported.` - -## Debian and Ubuntu - -Users of Debian 9 or later or Ubuntu 16.04 or later may simply -`apt-get install elpa-helm` (or `apt-get install elpa-helm-core`; see -below). - -## Installing just the helm-core package - -`helm-core` package is available on [MELPA](http://melpa.org/) for -third party packages that depend on helm libraries. These packages -should require helm as follows: - - (require 'helm) - -Requiring helm builds and runs helm code necessary for multiple regexp -and fuzzy matching. See -[helm wiki](https://github.com/emacs-helm/helm/wiki#developpingusinghelmframework) -for details. - -## Warning about alternate installation methods - -Installation methods that circumvent `helm-config` are known to fail -if the careful safeguards are not implemented in the hacks. - ## Configuration -For minimal helm configuration, run the start-up script `./emacs-helm.sh` -and then see the file `/tmp/helm-cfg.el`. +For minimal helm configuration, run the start-up script +`/usr/share/doc/elpa-helm/emacs-helm.sh` and then see the file +`/tmp/helm-cfg.el`. The full configuration I (the helm maintainer) use is [here](https://github.com/thierryvolpiatto/emacs-tv-config/blob/master/init-helm-thierry.el). @@ -200,9 +102,9 @@ To make helm-mode start with Emacs init file: To discover helm commands, look at helm menu item in Emacs menu. Another way to discover helm commands: run the shell script: -`./emacs-helm.sh` and then look in the scratch buffer. `emacs-helm.sh` -accepts emacs command line options. `emacs-helm.sh -h` opens an Info -screen with more details. +`/usr/share/doc/elpa-helm/examples/emacs-helm.sh` and then look in the +scratch buffer. `emacs-helm.sh` accepts emacs command line +options. `emacs-helm.sh -h` opens an Info screen with more details. ## Advanced usage @@ -210,7 +112,7 @@ Helm contains many features, some of which are easier to follow visually. Here is a demo of `helm-buffers-list` used with `helm-moccur`. Demo starts with `Eval: START` in the minibuffer. -![helm-buffers-list](doc/helm-buffers-list.gif) +![helm-buffers-list](helm-buffers-list.gif) - Regexp `*C` selects the C buffers. `*Tcl` in the demo selects TCL buffers, then with `*C` switches back to C buffers. @@ -350,8 +252,8 @@ interacts with many Emacs features, bugs may be related to Emacs itself. One way to ascertain that the bugs are helm-related, recreate the -error either by using `Emacs -Q` or by running the included package -script `./emacs-helm.sh` located in the helm directory. +error either by using `Emacs -Q` or by running the included script +`/usr/share/doc/elpa-helm/examples/emacs-helm.sh`. # Getting help @@ -361,5 +263,3 @@ are two readily available locations. Cheers,<br> The Helm Team - -[badge-license]: https://img.shields.io/badge/license-GPL_3-green.svg |