summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAymeric Agon-Rambosson <aymeric.agon@yandex.com>2022-08-18 10:25:32 +0200
committerAymeric Agon-Rambosson <aymeric.agon@yandex.com>2022-10-07 15:43:27 -0700
commit7e0a0e0c6c1446ed3380c57e91a00d65aa7c7aa3 (patch)
treeaa4eef8a8a89fa09467686f918c8ff8e84465665
parent19979a3b1d30c62bd5d8bebb9e7e5041bda71812 (diff)
Drop references to external pages and debianisearchive/debian/0.17-1
Forwarded: not-needed Gbp-Pq: Name replace-external-references-when-possible.patch
-rw-r--r--README.org33
1 files changed, 15 insertions, 18 deletions
diff --git a/README.org b/README.org
index 62a01f1..31bd06b 100644
--- a/README.org
+++ b/README.org
@@ -107,7 +107,7 @@ indicates a category of =buffer=. Embark has the related notion of the
/type/ of a target for actions, and by default when category metadata
is present it is taken to be the type of minibuffer completion
candidates when used as targets. Emacs commands often do not set
-useful category metadata so the [[https://github.com/minad/marginalia][Marginalia]] package, which supplies
+useful category metadata so the Marginalia (=apt install elpa-marginalia=) package, which supplies
this missing metadata, is highly recommended for use with Embark.
Embark's default configuration has actions for the following target
@@ -183,11 +183,11 @@ sets:
Ibuffer buffer; and if they are packages you get a buffer in
package menu mode.
- If you use the grepping commands from the [[https://github.com/minad/consult/][Consult]] package,
+ If you use the grepping commands from the Consult (=apt install elpa-consult=) package,
=consult-grep=, =consult-git-grep= or =consult-ripgrep=, then you'll
probably want to install and load the =embark-consult= package, which
adds support for exporting a list of grep results to an honest
- grep-mode buffer, on which you can even use [[https://github.com/mhayashi1120/Emacs-wgrep][wgrep]] if you wish.
+ grep-mode buffer, on which you can even use wgrep (=apt install elpa-wgrep=) if you wish.
When in doubt choosing between exporting and collecting, a good rule
of thumb is to always prefer =embark-export= since when an exporter to a
@@ -275,21 +275,18 @@ switch to =find-file=.
* Quick start
-The easiest way to install Embark is from GNU ELPA, just run =M-x
-package-install RET embark RET=. (It is also available on MELPA.) It is
-highly recommended to also install [[https://github.com/minad/marginalia][Marginalia]] (also available on GNU
-ELPA), so that Embark can offer you preconfigured actions in more
+The easiest way to install Embark is ~apt install elpa-embark~. It is
+highly recommended to also install Marginalia (~apt install elpa-marginalia~),
+so that Embark can offer you preconfigured actions in more
contexts. For =use-package= users, the following is a very reasonable
starting configuration:
#+begin_src emacs-lisp
(use-package marginalia
- :ensure t
:config
(marginalia-mode))
(use-package embark
- :ensure t
:bind
(("C-." . embark-act) ;; pick some comfortable binding
@@ -309,9 +306,9 @@ starting configuration:
nil
(window-parameters (mode-line-format . none)))))
- ;; Consult users will also want the embark-consult package.
+ ;; Consult users will also want the elpa-embark-consult package,
+ ;; available with "apt install elpa-embark-consult".
(use-package embark-consult
- :ensure t
:after (embark consult)
:demand t ; only necessary if you have the hook below
;; if you want to have consult previews as you move around an
@@ -357,9 +354,9 @@ Embark needs to know what your minibuffer completion system considers
to be the list of candidates and which one is the current candidate.
Embark works out of the box if you use Emacs's default tab completion,
the built-in =icomplete-mode= or =fido-mode=, or the third-party packages
-[[https://github.com/minad/vertico][Vertico]], [[https://github.com/raxod502/selectrum/][Selectrum]] or [[https://github.com/abo-abo/swiper][Ivy]].
+Vertico (~apt install elpa-vertico~), [[https://github.com/raxod502/selectrum/][Selectrum]] or Ivy (~apt install elpa-ivy~).
-If you are a [[https://emacs-helm.github.io/helm/][Helm]] or [[https://github.com/abo-abo/swiper][Ivy]] user you are unlikely to want Embark since
+If you are a Helm (~apt install elpa-helm~) or Ivy user you are unlikely to want Embark since
those packages include comprehensive functionality for acting on
minibuffer completion candidates. (Embark does come with Ivy
integration despite this.)
@@ -404,7 +401,7 @@ Embark comes with the following indicators:
lazily highlights all occurrences of that symbol in the current
buffer, like isearch; also on by default.
-Users of the popular [[https://github.com/justbur/emacs-which-key][which-key]] package may prefer to use the
+Users of the popular which-key (~apt install elpa-which-key~) package may prefer to use the
=embark-which-key-indicator= from the [[https://github.com/oantolin/embark/wiki/Additional-Configuration#use-which-key-like-a-key-menu-prompt][Embark wiki]]. Just copy its
definition from the wiki into your configuration and customize the
=embark-indicators= user option to exclude the mixed and verbose
@@ -655,7 +652,7 @@ similar situations where the easiest option is not available.
*** New minibuffer target example - tab-bar tabs
-As an example, take the new [[https://www.gnu.org/software/emacs/manual/html_node/emacs/Tab-Bars.html][tab bars]] from Emacs 27. I'll explain how
+As an example, take the new [[info:emacs#Tab Bars][tab bars]] from Emacs 27. I'll explain how
to configure Embark to offer tab-specific actions when you use the
tab-bar-mode commands that mention tabs by name. The configuration
explained here is now built-in to Embark (and Marginalia), but it's
@@ -673,7 +670,7 @@ for example, do have metadata indicating that they want a =file=.) They
do not, unfortunately, and I will describe a couple of ways to deal
with this.
-Maybe the easiest thing is to configure [[https://github.com/minad/marginalia][Marginalia]] to enhance those
+Maybe the easiest thing is to configure Marginalia to enhance those
commands. All of the =tab-bar-*-tab-by-name= commands have the words
"tab by name" in the minibuffer prompt, so you can use:
@@ -706,7 +703,7 @@ metadata looks:
As you can see, the built-in support for setting the category
meta-datum is not very easy to use or pretty to look at. To help with
this I recommend the =consult--read= function from the excellent
-[[https://github.com/minad/consult/][Consult]] package. With that function we can rewrite the command as
+Consult package. With that function we can rewrite the command as
follows:
#+begin_src emacs-lisp
@@ -918,7 +915,7 @@ included in the list =embark-indicators=).
* Embark, Marginalia and Consult
-Embark cooperates well with the [[https://github.com/minad/marginalia][Marginalia]] and [[https://github.com/minad/consult][Consult]] packages.
+Embark cooperates well with the Marginalia (~apt install elpa-marginalia~) and Consult (~apt install elpa-consult~) packages.
Neither of those packages is a dependency of Embark, but both are
highly recommended companions to Embark, for opposite reasons:
Marginalia greatly enhances Embark's usefulness, while Embark can help