From 494a90dcb1f5c86edbfd5535d044b1435dc77879 Mon Sep 17 00:00:00 2001 From: Lucien Cartier-Tilet Date: Sun, 14 Nov 2021 18:55:43 +0100 Subject: [PATCH] Update README, package is now in melpa Update recipes for installing package Add MELPA badge --- README.org | 15 +++++++-------- 1 file changed, 7 insertions(+), 8 deletions(-) diff --git a/README.org b/README.org index 5d06769..81efc0b 100644 --- a/README.org +++ b/README.org @@ -1,6 +1,8 @@ #+title: eshell-info-banner.el #+author: Lucien Cartier-Tilet #+email: lucien@phundrak.com +[[https://melpa.org/#/eshell-info-banner][file:https://melpa.org/packages/eshell-info-banner-badge.svg]] + * Introduction ~eshell-info-banner.el~ is a utility for creating an informative banner, akin to ~fish_greeting~ but for Eshell. But an image is worth a thousand @@ -60,12 +62,12 @@ your ~load-path~ and add the following to your ~.emacs~ or your ~init.el~: (add-hook 'eshell-banner-load-hook 'eshell-info-banner-update-banner) #+end_src -If you use ~use-package~ only, you can then install it like so: +If you use ~use-package~ only and install the package from MELPA, you +can then install it like so: #+begin_src emacs-lisp (use-package eshell-info-banner :ensure t :defer t - :load-path "~/path/to/where/you/cloned/it/eshell-info-banner.el/" :hook (eshell-banner-load . eshell-info-banner-update-banner)) #+end_src @@ -74,15 +76,12 @@ In my case, I prefer using ~use-package~ with ~straight~: (use-package eshell-info-banner :ensure t :defer t - :straight (eshell-info-banner :type git - :host github - :repo "phundrak/eshell-info-banner.el") + :straight (:build t) :hook (eshell-banner-load . eshell-info-banner-update-banner)) #+end_src -I personally also added ~:build t~ in the straight recipe to ensure -Emacs compiles my package, both to ~.elc~ and ~.eln~ files (I am on Emacs -28.0, ~feature/native-comp~ got merged into ~master~!) +You can just use ~:straight t~ if you do not want to ensure the package +gets compiled by Emacs. There is probably a similar way to install it with pure ~straight.el~ or ~quelpa~, but I’m not knowledgable enough for that, feel free to create