Update README, package is now in melpa
Update recipes for installing package Add MELPA badge
This commit is contained in:
		
							parent
							
								
									33684943c3
								
							
						
					
					
						commit
						494a90dcb1
					
				
							
								
								
									
										15
									
								
								README.org
									
									
									
									
									
								
							
							
						
						
									
										15
									
								
								README.org
									
									
									
									
									
								
							@ -1,6 +1,8 @@
 | 
				
			|||||||
#+title: eshell-info-banner.el
 | 
					#+title: eshell-info-banner.el
 | 
				
			||||||
#+author: Lucien Cartier-Tilet
 | 
					#+author: Lucien Cartier-Tilet
 | 
				
			||||||
#+email: lucien@phundrak.com
 | 
					#+email: lucien@phundrak.com
 | 
				
			||||||
 | 
					[[https://melpa.org/#/eshell-info-banner][file:https://melpa.org/packages/eshell-info-banner-badge.svg]]
 | 
				
			||||||
 | 
					
 | 
				
			||||||
* Introduction
 | 
					* Introduction
 | 
				
			||||||
~eshell-info-banner.el~ is a utility for creating an informative banner,
 | 
					~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
 | 
					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)
 | 
					  (add-hook 'eshell-banner-load-hook 'eshell-info-banner-update-banner)
 | 
				
			||||||
#+end_src
 | 
					#+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
 | 
					#+begin_src emacs-lisp
 | 
				
			||||||
  (use-package eshell-info-banner
 | 
					  (use-package eshell-info-banner
 | 
				
			||||||
    :ensure t
 | 
					    :ensure t
 | 
				
			||||||
    :defer t
 | 
					    :defer t
 | 
				
			||||||
    :load-path "~/path/to/where/you/cloned/it/eshell-info-banner.el/"
 | 
					 | 
				
			||||||
    :hook (eshell-banner-load . eshell-info-banner-update-banner))
 | 
					    :hook (eshell-banner-load . eshell-info-banner-update-banner))
 | 
				
			||||||
#+end_src
 | 
					#+end_src
 | 
				
			||||||
 | 
					
 | 
				
			||||||
@ -74,15 +76,12 @@ In my case, I prefer using ~use-package~ with ~straight~:
 | 
				
			|||||||
  (use-package eshell-info-banner
 | 
					  (use-package eshell-info-banner
 | 
				
			||||||
    :ensure t
 | 
					    :ensure t
 | 
				
			||||||
    :defer t
 | 
					    :defer t
 | 
				
			||||||
    :straight (eshell-info-banner :type git
 | 
					    :straight (:build t)
 | 
				
			||||||
                                  :host github
 | 
					 | 
				
			||||||
                                  :repo "phundrak/eshell-info-banner.el")
 | 
					 | 
				
			||||||
    :hook (eshell-banner-load . eshell-info-banner-update-banner))
 | 
					    :hook (eshell-banner-load . eshell-info-banner-update-banner))
 | 
				
			||||||
#+end_src
 | 
					#+end_src
 | 
				
			||||||
 | 
					
 | 
				
			||||||
I personally also added ~:build t~ in the straight recipe to ensure
 | 
					You can just use ~:straight t~ if you do not want to ensure the package
 | 
				
			||||||
Emacs compiles my package, both to ~.elc~ and ~.eln~ files (I am on Emacs
 | 
					gets compiled by Emacs.
 | 
				
			||||||
28.0, ~feature/native-comp~ got merged into ~master~!)
 | 
					 | 
				
			||||||
 | 
					
 | 
				
			||||||
There is probably a similar way to install it with pure ~straight.el~ or
 | 
					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
 | 
					~quelpa~, but I’m not knowledgable enough for that, feel free to create
 | 
				
			||||||
 | 
				
			|||||||
		Loading…
	
	
			
			x
			
			
		
	
		Reference in New Issue
	
	Block a user