[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[elpa] externals/ivy fff7b89 3/3: Merge branch 'master' into externals/i
From: |
Basil L. Contovounesios |
Subject: |
[elpa] externals/ivy fff7b89 3/3: Merge branch 'master' into externals/ivy |
Date: |
Thu, 11 Mar 2021 11:43:56 -0500 (EST) |
branch: externals/ivy
commit fff7b890bc2b498da82354c5b99ee3865c4e83f8
Merge: 3595d5a 8866138
Author: Basil L. Contovounesios <contovob@tcd.ie>
Commit: Basil L. Contovounesios <contovob@tcd.ie>
Merge branch 'master' into externals/ivy
---
README.md | 62 ++++++++++++++++++++++++++++++-------------------------
doc/Changelog.org | 2 +-
doc/ivy.org | 13 ++++++------
doc/ivy.texi | 15 +++++++-------
4 files changed, 50 insertions(+), 42 deletions(-)
diff --git a/README.md b/README.md
index f1ce587..877885e 100644
--- a/README.md
+++ b/README.md
@@ -9,10 +9,12 @@ This repository contains:
**Counsel**, a collection of Ivy-enhanced versions of common Emacs
commands.
-**Swiper**, an Ivy-enhanced alternative to isearch.
+**Swiper**, an Ivy-enhanced alternative to Isearch.
# Ivy
+[![GNU-devel
ELPA](https://img.shields.io/badge/gnu_elpa-devel-922793)](https://elpa.gnu.org/devel/ivy.html)
+[![GNU
ELPA](https://img.shields.io/badge/gnu_elpa-stable-3e999f)](https://elpa.gnu.org/packages/ivy.html)
[![MELPA](https://melpa.org/packages/ivy-badge.svg)](https://melpa.org/#/ivy)
[![MELPA
Stable](https://stable.melpa.org/packages/ivy-badge.svg)](https://stable.melpa.org/#/ivy)
@@ -27,7 +29,7 @@ buffer names.
### Installation
-Install the `ivy` package from MELPA / GNU ELPA.
+Install the `ivy` package from GNU ELPA or MELPA.
Users of Debian ≥10 (and derivatives such as Ubuntu ≥18.04) can
install Ivy, Counsel, and Swiper with `sudo apt install elpa-counsel`.
@@ -38,10 +40,10 @@ To add Hydra support `sudo apt install elpa-ivy-hydra`.
### Manual
The manual is available as [HTML](https://oremacs.com/swiper/).
-After installing from MELPA, the manual is also available through the `(ivy)`
Info node.
+Installing `ivy` from GNU ELPA or MELPA also installs the manual under
+the `(ivy)` Info node.
-The source file for the Info page is
-[here](https://github.com/abo-abo/swiper/blob/master/doc/ivy.org).
+The source file for the Info page is [here](doc/ivy.org).
### Wiki
Ivy and Swiper wiki is here: [the
wiki](https://github.com/abo-abo/swiper/wiki).
@@ -49,7 +51,7 @@ Ivy and Swiper wiki is here: [the
wiki](https://github.com/abo-abo/swiper/wiki).
### Small config example
```elisp
-(ivy-mode 1)
+(ivy-mode)
(setq ivy-use-virtual-buffers t)
(setq enable-recursive-minibuffers t)
;; enable this if you want `swiper' to use it
@@ -77,6 +79,8 @@ Note: parts of this config can be replaced by using
`counsel-mode`.
# Counsel
+[![GNU-devel
ELPA](https://img.shields.io/badge/gnu_elpa-devel-922793)](https://elpa.gnu.org/devel/counsel.html)
+[![GNU
ELPA](https://img.shields.io/badge/gnu_elpa-stable-3e999f)](https://elpa.gnu.org/packages/counsel.html)
[![MELPA](https://melpa.org/packages/counsel-badge.svg)](https://melpa.org/#/counsel)
[![MELPA
Stable](https://stable.melpa.org/packages/counsel-badge.svg)](https://stable.melpa.org/#/counsel)
@@ -84,43 +88,45 @@ Note: parts of this config can be replaced by using
`counsel-mode`.
`completing-read-function` uses ivy for completion.
Counsel takes this further, providing versions of common Emacs
-commands that are customised to make the best use of ivy. For example,
+commands that are customised to make the best use of Ivy. For example,
`counsel-find-file` has some additional keybindings. Pressing
<kbd>DEL</kbd> will move you to the parent directory.
Enabling `counsel-mode` remaps built-in Emacs functions that have
counsel replacements:
-| Emacs command | Counsel equivalent |
-|--------------------------|----------------------------|
-| execute-extended-command | counsel-M-x |
-| describe-bindings | counsel-descbinds |
-| describe-function | counsel-describe-function |
-| describe-variable | counsel-describe-variable |
-| apropos-command | counsel-apropos |
-| describe-face | counsel-describe-face |
-| list-faces-display | counsel-faces |
-| find-file | counsel-find-file |
-| find-library | counsel-find-library |
-| imenu | counsel-imenu |
-| load-library | counsel-load-library |
-| load-theme | counsel-load-theme |
-| yank-pop | counsel-yank-pop |
-| info-lookup-symbol | counsel-info-lookup-symbol |
-| pop-to-mark-command | counsel-mark-ring |
-| bookmark-jump | counsel-bookmark |
+| Emacs command | Counsel equivalent |
+|----------------------------|------------------------------|
+| `execute-extended-command` | `counsel-M-x` |
+| `describe-bindings` | `counsel-descbinds` |
+| `describe-function` | `counsel-describe-function` |
+| `describe-variable` | `counsel-describe-variable` |
+| `apropos-command` | `counsel-apropos` |
+| `describe-face` | `counsel-describe-face` |
+| `list-faces-display` | `counsel-faces` |
+| `find-file` | `counsel-find-file` |
+| `find-library` | `counsel-find-library` |
+| `imenu` | `counsel-imenu` |
+| `load-library` | `counsel-load-library` |
+| `load-theme` | `counsel-load-theme` |
+| `yank-pop` | `counsel-yank-pop` |
+| `info-lookup-symbol` | `counsel-info-lookup-symbol` |
+| `pop-to-mark-command` | `counsel-mark-ring` |
+| `bookmark-jump` | `counsel-bookmark` |
# Swiper
+[![GNU-devel
ELPA](https://img.shields.io/badge/gnu_elpa-devel-922793)](https://elpa.gnu.org/devel/swiper.html)
+[![GNU
ELPA](https://img.shields.io/badge/gnu_elpa-stable-3e999f)](https://elpa.gnu.org/packages/swiper.html)
[![MELPA](https://melpa.org/packages/swiper-badge.svg)](https://melpa.org/#/swiper)
[![MELPA
Stable](https://stable.melpa.org/packages/swiper-badge.svg)](https://stable.melpa.org/#/swiper)
-Swiper is an alternative to isearch that uses ivy to show an overview
+Swiper is an alternative to isearch that uses Ivy to show an overview
of all matches.
![swiper.png](https://oremacs.com/download/swiper.png)
-A helm version of swiper is also available:
+A Helm version of Swiper is also available:
[swiper-helm](https://github.com/abo-abo/swiper-helm).
## Screenshots
@@ -139,4 +145,4 @@ A: Press <kbd>C-M-j</kbd>. Alternatively, you can make the
prompt line selectabl
# Contributing
-Please see the
[guidelines](https://github.com/abo-abo/swiper/blob/master/CONTRIBUTING.org)
for reporting issues and opening pull requests.
+Please see the [guidelines](CONTRIBUTING.org) for reporting issues and opening
pull requests.
diff --git a/doc/Changelog.org b/doc/Changelog.org
index 3557215..80e433b 100644
--- a/doc/Changelog.org
+++ b/doc/Changelog.org
@@ -2111,7 +2111,7 @@ See
[[https://github.com/abo-abo/swiper/issues/577][#577]].
See [[https://github.com/abo-abo/swiper/issues/601][#601]].
**** Added info on associating values
See [[https://github.com/abo-abo/swiper/issues/714][#714]].
-**** Update package names on ELPA/MELPA
+**** Update package names on GNU ELPA / MELPA
See [[https://github.com/abo-abo/swiper/issues/833][#833]].
-----
*** =ivy--filter=
diff --git a/doc/ivy.org b/doc/ivy.org
index dd67060..d8b2d20 100644
--- a/doc/ivy.org
+++ b/doc/ivy.org
@@ -150,22 +150,23 @@ version that runs Ivy with fancy faces display.
~M-x~ =package-install= ~RET~ =counsel= ~RET~
-Ivy is installed as part of the =counsel= package, which is available
+Ivy is installed alongside the =counsel= package, which is available
from two different package archives, GNU ELPA and MELPA. For the
-latest stable version, use the GNU ELPA archives. For current hourly
-builds, use the MELPA archives.
+latest stable version, use the GNU ELPA archive. For the latest
+development snaphshot, use the GNU-devel ELPA archive.
Ivy is split into three packages: =ivy=, =swiper= and =counsel=; by
installing =counsel=, the other two are brought in as dependencies.
If you are not interested in the extra functionality provided by
=swiper= and =counsel=, you can install only =ivy=.
-See the code below for adding MELPA to the list of package archives:
+See the code below for adding GNU-devel ELPA to your list of package
+archives:
#+begin_src elisp
(require 'package)
(add-to-list 'package-archives
- '("melpa" . "https://melpa.org/packages/"))
+ '("gnu-devel" . "https://elpa.gnu.org/devel/"))
#+end_src
After this do ~M-x~ =package-refresh-contents= ~RET~, followed by ~M-x~
@@ -180,7 +181,7 @@ For package manager details, see [[info:emacs#Packages]].
- Why install from Git? ::
- - No need to wait for MELPA's hourly builds
+ - No need to wait for GNU ELPA / MELPA builds
- Easy to revert to previous versions
- Contribute to Ivy's development; send patches; pull requests
diff --git a/doc/ivy.texi b/doc/ivy.texi
index 815fac2..dc697a6 100644
--- a/doc/ivy.texi
+++ b/doc/ivy.texi
@@ -217,22 +217,23 @@ version that runs Ivy with fancy faces display.
@kbd{M-x} @code{package-install} @kbd{RET} @code{counsel} @kbd{RET}
-Ivy is installed as part of the @code{counsel} package, which is available
+Ivy is installed alongside the @code{counsel} package, which is available
from two different package archives, GNU ELPA and MELPA@. For the
-latest stable version, use the GNU ELPA archives. For current hourly
-builds, use the MELPA archives.
+latest stable version, use the GNU ELPA archive. For the latest
+development snaphshot, use the GNU-devel ELPA archive.
Ivy is split into three packages: @code{ivy}, @code{swiper} and
@code{counsel}; by
installing @code{counsel}, the other two are brought in as dependencies.
If you are not interested in the extra functionality provided by
@code{swiper} and @code{counsel}, you can install only @code{ivy}.
-See the code below for adding MELPA to the list of package archives:
+See the code below for adding GNU-devel ELPA to your list of package
+archives:
@lisp
(require 'package)
(add-to-list 'package-archives
- '("melpa" . "https://melpa.org/packages/"))
+ '("gnu-devel" . "https://elpa.gnu.org/devel/"))
@end lisp
After this do @kbd{M-x} @code{package-refresh-contents} @kbd{RET}, followed by
@kbd{M-x}
@@ -247,7 +248,7 @@ For package manager details, see @ref{Packages,,,emacs,}.
@indentedblock
@itemize
@item
-No need to wait for MELPA's hourly builds
+No need to wait for GNU ELPA / MELPA builds
@item
Easy to revert to previous versions
@item
@@ -1827,4 +1828,4 @@ then retrieves that value and displays it.
@printindex ky
-@bye
\ No newline at end of file
+@bye