branch: externals/denote-search commit 48ba86f0fb5cb0ab1d46c9fa5cc6b8baaba18359 Author: Lucas Quintana <lm...@protonmail.com> Commit: Lucas Quintana <lm...@protonmail.com>
Update installation instructions after ELPA publication --- README.md | 21 +++++++++++---------- README.org | 26 +++++++++++++++----------- 2 files changed, 26 insertions(+), 21 deletions(-) diff --git a/README.md b/README.md index 8fd5ee619c..7d22b176d6 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,7 @@ # denote-search: A simple search utility for Denote +#+html: <a href="https://elpa.gnu.org/packages/denote-search.html"><img alt="GNU ELPA" src="https://elpa.gnu.org/packages/denote-search.svg"/></a> + This package provides a search utility for Denote, the simple-to-use, focused-in-scope, and effective note-taking tool for Emacs. @@ -19,8 +21,14 @@ See the `README.org` file for a comprehensive manual. ## Installation -If you are using Emacs 29.1 onwards, you can install the package by -evaluating the following code: +denote-search is available in GNU ELPA. You can install the package by doing: + +``` +M-x package-refresh-contents RET +M-x package-install RET denote-search RET +``` + +If for whatever reason you prefer to install it from source, you can do so by evaluating the following code: ```elisp (package-vc-install @@ -29,15 +37,11 @@ evaluating the following code: :doc "README.org")) ``` -Alternatively, you can use the :vc keyword from use-package, as shown -in the sample configuration: +## Sample configuration ```elisp (use-package denote-search :ensure t - ;; Installation with VC - :vc (:url "https://github.com/lmq-10/denote-search" - :rev :newest) :bind ;; Customize keybindings to your liking (("C-c s s" . denote-search) @@ -49,6 +53,3 @@ in the sample configuration: ;; Display keywords in results buffer (denote-search-format-heading-function #'denote-search-format-heading-with-keywords)) ``` - -Of course, you can also install it manually or use an alternative -package manager such as quelpa. diff --git a/README.org b/README.org index 67407cf43f..d5e5c8dcbb 100644 --- a/README.org +++ b/README.org @@ -398,8 +398,19 @@ additional configuration. * Installation -If you are using Emacs 29.1 onwards, you can install the package by -evaluating the following code: +** GNU ELPA package + +The package is available as denote-search. Simply do: + +: M-x package-refresh-contents +: M-x package-install + +And search for it. + +** VC installation + +You can install the package from source by evaluating the following +code: #+begin_src elisp (package-vc-install @@ -408,11 +419,7 @@ evaluating the following code: :doc "README.org")) #+end_src -Alternatively, you can use the :vc keyword from use-package, as shown -in the [[#sample-configuration][sample configuration]]. - -Of course, you can also [[#manual-installation][install it manually]] or use an alternative -package manager such as quelpa. +Alternatively, you can use the :vc keyword from use-package. ** Manual installation :PROPERTIES: @@ -452,9 +459,6 @@ Everything is in place to set up the package. #+begin_src elisp (use-package denote-search :ensure t - ;; Installation with VC - :vc (:url "https://github.com/lmq-10/denote-search" - :rev :newest) :bind ;; Customize keybindings to your liking (("C-c s s" . denote-search) @@ -484,7 +488,7 @@ effort. Every bit of help matters. + Author/maintainer :: Lucas Quintana. -+ Contributions to code :: Grant Rettke. ++ Contributions to code :: Grant Rettke, Philip Kaludercic. If ~denote-search~ exists it's because Protesilaos Stavrou developed the incredible Denote package. Please consider donating to him.[fn:2]