Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add recipes for additional packages README in private/local dir #13209

Closed
wants to merge 2 commits into from
Closed
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 31 additions & 2 deletions private/local/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
`(require '~/.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.