Skip to content

Commit 2257a9d

Browse files
committed
Fix Installation and links in README
This removes links to https://oremacs.com, which is currently down. * README.md: Define full link references with titles. Touch up markup, wording, and alt text. Add an Installation section for each package (#3073). Remove broken swiper.png link which IIRC was to an unattributed third-party image. Replace broken ivy-swiper-1.png link with... * swiper.svg: ...this new x-export-frames screenshot. Fixes #3073.
1 parent 2529a23 commit 2257a9d

File tree

2 files changed

+2035
-28
lines changed

2 files changed

+2035
-28
lines changed

README.md

Lines changed: 131 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,22 @@
1-
[![Build Status](https://github.com/abo-abo/swiper/actions/workflows/test.yml/badge.svg)](https://github.com/abo-abo/swiper/actions/workflows/test.yml)
1+
[![CI build badge][ci-badge]][ci]
22

3-
***flexible, simple tools for minibuffer completion in Emacs***
3+
***Flexible, simple tools for minibuffer completion in Emacs***
44

55
This repository contains:
66

7-
**Ivy**, a generic completion mechanism for Emacs.
7+
- [**Ivy**](#ivy), a generic completion mechanism for Emacs.
88

9-
**Counsel**, a collection of Ivy-enhanced versions of common Emacs
10-
commands.
9+
- [**Counsel**](#counsel), a collection of Ivy-enhanced versions of
10+
common Emacs commands.
1111

12-
**Swiper**, an Ivy-enhanced alternative to Isearch.
12+
- [**Swiper**](#swiper), an Ivy-enhanced alternative to Isearch.
1313

1414
# Ivy
1515

16-
[![GNU-devel ELPA](https://elpa.gnu.org/devel/ivy.svg)](https://elpa.gnu.org/devel/ivy.html)
17-
[![GNU ELPA](https://elpa.gnu.org/packages/ivy.svg)](https://elpa.gnu.org/packages/ivy.html)
18-
[![MELPA](https://melpa.org/packages/ivy-badge.svg)](https://melpa.org/#/ivy)
19-
[![MELPA Stable](https://stable.melpa.org/packages/ivy-badge.svg)](https://stable.melpa.org/#/ivy)
16+
[![Ivy badge from GNU-devel ELPA][ivy-dev-badge]][ivy-dev]
17+
[![Ivy badge from GNU ELPA][ivy-badge]][ivy]
18+
[![Ivy badge from MELPA][ivy-melpa-badge]][ivy-melpa]
19+
[![Ivy badge from MELPA Stable][ivy-stable-badge]][ivy-stable]
2020

2121
Ivy is a generic completion mechanism for Emacs. While it operates
2222
similarly to other completion schemes such as `icomplete-mode`, Ivy
@@ -27,7 +27,7 @@ To try Ivy, just call <kbd>M-x</kbd> `ivy-mode`. This will enable
2727
generic Ivy completion, including specific completion for file and
2828
buffer names.
2929

30-
### Installation
30+
## Installation
3131

3232
Install the `ivy` package from GNU ELPA or MELPA.
3333

@@ -42,13 +42,13 @@ To add Hydra support: `sudo apt install elpa-ivy-hydra`.
4242
Installing `ivy` from GNU ELPA or MELPA also installs the manual under
4343
the `(ivy)` Info node.
4444

45-
The source file for the Info page is [here](doc/ivy.org).
45+
The source file for the Info manual is [`ivy.org`](doc/ivy.org).
4646

47-
The manual is also available as [HTML](https://elpa.gnu.org/packages/doc/ivy.html).
47+
The manual is also available as [HTML][ivy-manual].
4848

4949
### Wiki
5050

51-
Ivy and Swiper wiki [is here](https://github.com/abo-abo/swiper/wiki).
51+
There is an Ivy and Swiper [wiki on GitHub][ivy-wiki].
5252

5353
### Small config example
5454

@@ -81,10 +81,10 @@ Note: parts of this config can be replaced by using `counsel-mode`.
8181

8282
# Counsel
8383

84-
[![GNU-devel ELPA](https://elpa.gnu.org/devel/counsel.svg)](https://elpa.gnu.org/devel/counsel.html)
85-
[![GNU ELPA](https://elpa.gnu.org/packages/counsel.svg)](https://elpa.gnu.org/packages/counsel.html)
86-
[![MELPA](https://melpa.org/packages/counsel-badge.svg)](https://melpa.org/#/counsel)
87-
[![MELPA Stable](https://stable.melpa.org/packages/counsel-badge.svg)](https://stable.melpa.org/#/counsel)
84+
[![Counsel badge from GNU-devel ELPA][counsel-dev-badge]][counsel-dev]
85+
[![Counsel badge from GNU ELPA][counsel-badge]][counsel]
86+
[![Counsel badge from MELPA][counsel-melpa-badge]][counsel-melpa]
87+
[![Counsel badge from MELPA Stable][counsel-stable-badge]][counsel-stable]
8888

8989
`ivy-mode` ensures that any Emacs command invoking `completing-read`
9090
or `completion-in-region` will use Ivy for completion.
@@ -98,7 +98,7 @@ Enabling `counsel-mode` remaps built-in Emacs functions that have
9898
Counsel replacements:
9999

100100
| Emacs command | Counsel counterpart |
101-
|----------------------------|------------------------------|
101+
| -------------------------- | ---------------------------- |
102102
| `execute-extended-command` | `counsel-M-x` |
103103
| `describe-bindings` | `counsel-descbinds` |
104104
| `describe-function` | `counsel-describe-function` |
@@ -117,26 +117,32 @@ Counsel replacements:
117117
| `pop-to-mark-command` | `counsel-mark-ring` |
118118
| `bookmark-jump` | `counsel-bookmark` |
119119

120+
## Installation
121+
122+
Install the `counsel` package from GNU ELPA or MELPA.
123+
120124
# Swiper
121125

122-
[![GNU-devel ELPA](https://elpa.gnu.org/devel/swiper.svg)](https://elpa.gnu.org/devel/swiper.html)
123-
[![GNU ELPA](https://elpa.gnu.org/packages/swiper.svg)](https://elpa.gnu.org/packages/swiper.html)
124-
[![MELPA](https://melpa.org/packages/swiper-badge.svg)](https://melpa.org/#/swiper)
125-
[![MELPA Stable](https://stable.melpa.org/packages/swiper-badge.svg)](https://stable.melpa.org/#/swiper)
126+
[![Swiper badge from GNU-devel ELPA][swiper-dev-badge]][swiper-dev]
127+
[![Swiper badge from GNU ELPA][swiper-badge]][swiper]
128+
[![Swiper badge from MELPA][swiper-melpa-badge]][swiper-melpa]
129+
[![Swiper badge from MELPA Stable][swiper-stable-badge]][swiper-stable]
126130

127131
Swiper is an alternative to Isearch that uses Ivy to show an overview
128132
of all matches.
129133

130-
![swiper.png](https://oremacs.com/download/swiper.png)
131-
132134
A Helm version of Swiper is also available:
133-
[`swiper-helm`](https://github.com/abo-abo/swiper-helm).
135+
[`swiper-helm`][swiper-helm].
136+
137+
## Installation
138+
139+
Install the `swiper` package from GNU ELPA or MELPA.
134140

135141
## Screenshots
136142

137-
![ivy-swiper-1.png](https://oremacs.com/download/ivy-swiper-1.png)
143+
![Screenshot of Swiper in Emacs][swiper-shot]
138144

139-
There's also a ten minute [video demo](https://youtu.be/VvnJQpTFVDc).
145+
There's also a ~ten minute [video demo][swiper-demo].
140146

141147
# Frequently asked questions
142148

@@ -154,3 +160,100 @@ There's also a ten minute [video demo](https://youtu.be/VvnJQpTFVDc).
154160

155161
Please see the [guidelines](CONTRIBUTING.org) for reporting issues and
156162
opening pull requests.
163+
164+
[ci]:
165+
https://github.com/abo-abo/swiper/actions/workflows/test.yml
166+
'CI build'
167+
[ci-badge]:
168+
https://github.com/abo-abo/swiper/actions/workflows/test.yml/badge.svg
169+
'CI build status'
170+
171+
[ivy-dev]:
172+
https://elpa.gnu.org/devel/ivy.html
173+
'Ivy on GNU-devel ELPA'
174+
[ivy-dev-badge]:
175+
https://elpa.gnu.org/devel/ivy.svg
176+
'Ivy version on GNU-devel ELPA'
177+
[ivy]:
178+
https://elpa.gnu.org/packages/ivy.html
179+
'Ivy on GNU ELPA'
180+
[ivy-badge]:
181+
https://elpa.gnu.org/packages/ivy.svg
182+
'Ivy version on GNU ELPA'
183+
[ivy-melpa]:
184+
https://melpa.org/#/ivy
185+
'Ivy on MELPA'
186+
[ivy-melpa-badge]:
187+
https://melpa.org/packages/ivy-badge.svg
188+
'Ivy version on MELPA'
189+
[ivy-stable]:
190+
https://stable.melpa.org/#/ivy
191+
'Ivy on MELPA Stable'
192+
[ivy-stable-badge]:
193+
https://stable.melpa.org/packages/ivy-badge.svg
194+
'Ivy version on MELPA Stable'
195+
[ivy-manual]:
196+
https://elpa.gnu.org/packages/doc/ivy.html
197+
'Ivy manual on GNU ELPA'
198+
[ivy-wiki]:
199+
https://github.com/abo-abo/swiper/wiki
200+
'Ivy wiki on GitHub'
201+
202+
[counsel-dev]:
203+
https://elpa.gnu.org/devel/counsel.html
204+
'Counsel on GNU-devel ELPA'
205+
[counsel-dev-badge]:
206+
https://elpa.gnu.org/devel/counsel.svg
207+
'Counsel version on GNU-devel ELPA'
208+
[counsel]:
209+
https://elpa.gnu.org/packages/counsel.html
210+
'Counsel on GNU ELPA'
211+
[counsel-badge]:
212+
https://elpa.gnu.org/packages/counsel.svg
213+
'Counsel version on GNU ELPA'
214+
[counsel-melpa]:
215+
https://melpa.org/#/counsel
216+
'Counsel on MELPA'
217+
[counsel-melpa-badge]:
218+
https://melpa.org/packages/counsel-badge.svg
219+
'Counsel version on MELPA'
220+
[counsel-stable]:
221+
https://stable.melpa.org/#/counsel
222+
'Counsel on MELPA Stable'
223+
[counsel-stable-badge]:
224+
https://stable.melpa.org/packages/counsel-badge.svg
225+
'Counsel version on MELPA Stable'
226+
227+
[swiper-dev]:
228+
https://elpa.gnu.org/devel/swiper.html
229+
'Swiper on GNU-devel ELPA'
230+
[swiper-dev-badge]:
231+
https://elpa.gnu.org/devel/swiper.svg
232+
'Swiper version on GNU-devel ELPA'
233+
[swiper]:
234+
https://elpa.gnu.org/packages/swiper.html
235+
'Swiper on GNU ELPA'
236+
[swiper-badge]:
237+
https://elpa.gnu.org/packages/swiper.svg
238+
'Swiper version on GNU ELPA'
239+
[swiper-melpa]:
240+
https://melpa.org/#/swiper
241+
'Swiper on MELPA'
242+
[swiper-melpa-badge]:
243+
https://melpa.org/packages/swiper-badge.svg
244+
'Swiper version on MELPA'
245+
[swiper-stable]:
246+
https://stable.melpa.org/#/swiper
247+
'Swiper on MELPA Stable'
248+
[swiper-stable-badge]:
249+
https://stable.melpa.org/packages/swiper-badge.svg
250+
'Swiper version on MELPA Stable'
251+
[swiper-helm]:
252+
https://github.com/abo-abo/swiper-helm
253+
'Swiper-Helm on GitHub'
254+
[swiper-shot]:
255+
swiper.svg
256+
'Swiper search for def and wip but not face'
257+
[swiper-demo]:
258+
https://youtu.be/VvnJQpTFVDc
259+
'Swiper demo on YouTube'

0 commit comments

Comments
 (0)