TakeV
/
spacemacs
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Improve README instructions how to use private/local directory

This commit is contained in:
Daniel Nicolai 2020-03-15 14:26:53 +01:00 committed by Maximilian Wolff
parent 65ef007792
commit e4557ffcc2
No known key found for this signature in database
GPG Key ID: 2DD07025BFDBD89A
2 changed files with 34 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
CHANGELOG.develop
View File

@ -3391,6 +3391,9 @@ Other:
- README.md:
- Fixed macOS documentation to install fonts (thanks to Sergio Morales)
- Updated Windows section, suggest official Emacs (thanks to ghost-420)
- private/local/README.md
- Improved instructions on how to use private/local directory for packages
(thanks to Daniel Nicolai)
*** Release notes summarized
Thanks to: Abhishek(Compro) Prasad, Deepak Khidia, Enze Chi, Grant Shangreaux,
Igor Almeida, Jiahao Jiang, Miciah Dashiel Butler Masters, Songpeng Zu, Ward

33
private/local/README.md
View File

@ -2,5 +2,34 @@
The content of this directory is ignored by Git.
This is the place to store the local packages that you define in
the `dotspacemacs-additional-packages` variable of your dotfile.
This is the place to store the local packages that you define in the
`dotspacemacs-additional-packages` variable of your dotfile.
Additional packages can be added using the same recipe as for [adding packages
to layers](https://develop.spacemacs.org/doc/LAYERS.html#packagesel) i.e.:
- For a local package:
- Load the file explicitly, using the full path to the file, by placing a
`(load "~/.emacs.d/private/local/package-name")` within the body of the
`dotspacemacs/user-config` function of your dotspacemacs file.
- Alternatively create a directory with the name of the package in the
`.emacs.d/private/local` directory, and add that directory to the load-path
variable by adding `(some-package :location local)` to the list
`dotspacemacs-additional-packages` within the `dotspacemacs/layers` function
of your dotspacemacs file. After placing your package file into this
package-directory the file can be loaded, without requiring the full path, by
placing a `(require 'package-name)` within the body of the
`dotspacemacs/user-config` function of your dotspacemacs file.
- If the package is on (M)ELPA simply add the package name to the list
`dotspacemacs-additional-packages` in your dotspacemacs file
- For a package hosted on github the recipe for github packages can be used i.e. add
```
(some-package :location (recipe
:fetcher github
:repo "some/repo"))
```
to the list `dotspacemacs-additional-packages` in your dotspacemacs file.