Skip to content

Commit 70ded8c

Browse files
authored
docs: Provide example setup for use-package on Emacs 30+ (#298)
* docs: Provide example setup for use-package on Emacs 30+ Newer versions of `use-package` provide a `:vc` keyword. Users can now install copilot.el on standard emacs without `quelpa` or `straight`. That version of `use-package` is already in Emacs 30. Updated `README.md` to show an example. * Formatting Changes - Removed the deepest headings. - Updated on line to be stylistically consistent with the file.
1 parent 535ef61 commit 70ded8c

File tree

1 file changed

+17
-6
lines changed

1 file changed

+17
-6
lines changed

README.md

Lines changed: 17 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -146,29 +146,40 @@ dotspacemacs-additional-packages
146146

147147
#### 1. Load `copilot.el`
148148

149-
##### Option 1: Load via `straight.el` or `quelpa` (recommended)
149+
##### Option 1: Load via use-package (recommended)
150150

151-
###### `straight.el`:
151+
###### Emacs 27-29:
152+
153+
`straight.el`:
152154

153155
```elisp
154156
(use-package copilot
155157
:straight (:host github :repo "copilot-emacs/copilot.el" :files ("*.el"))
156158
:ensure t)
157-
;; you can utilize :map :hook and :config to customize copilot
158159
```
159160

160-
###### `quelpa` + `quelpa-use-package`:
161+
`quelpa` + `quelpa-use-package`:
161162

162163
```elisp
163164
(use-package copilot
164165
:quelpa (copilot :fetcher github
165166
:repo "copilot-emacs/copilot.el"
166167
:branch "main"
167168
:files ("*.el")))
168-
;; you can utilize :map :hook and :config to customize copilot
169169
```
170170

171-
##### Option 2: Load manually
171+
###### On Emacs version 30+:
172+
173+
```elisp
174+
(use-package copilot
175+
:vc (:url "https://github.com/copilot-emacs/copilot.el"
176+
:rev :newest
177+
:branch "main"))
178+
```
179+
180+
Use `:map` `:hook` and `:config` to customize `copilot.el` via `use-package`.
181+
182+
##### Option 3: Load manually
172183

173184
Please make sure you have these dependencies installed (available in ELPA/MELPA):
174185

0 commit comments

Comments
 (0)