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

Add documentation for additional contrib layer paths in readme

This commit is contained in:
syl20bnr 2014-10-23 22:33:16 -04:00
parent 93e1ff2546
commit 15876157e4
1 changed files with 18 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
README.md
View File

@ -283,10 +283,11 @@ Some user configuration can be performed in your `~/.spacemacs` file.
### Adding contributions
`Spacemacs` leverages the configuration layers in order to make it possible for
you to share your own layer with other `Spacemacs` users.
you to share your own layer with other `Spacemacs` users. This kind of layer is
called `contribution layer`.
To use a contribution layer, add it to the `dotspacemacs-configuration-layers`
variable of your `~/.spacemacs`
variable of your `~/.spacemacs`.
For instance to add the configuration layer of [RMS](#thank-you):
```elisp
@ -297,6 +298,21 @@ For instance to add the configuration layer of [RMS](#thank-you):
Oh, you don't find this configuration layer ? So sad, well you can try mine:
[syl20bnr](https://github.com/syl20bnr/spacemacs/tree/master/contrib/syl20bnr)
By default contribution layers are expected to be stored in `~/.emacs.d/contrib`
and we encourage you to submit your layers upstream in order to share them,
grow the package coverage of `Spacemacs` and dispatch responsibilities for their
maintenance. But of course you are free to keep them somewhere else, if this is
your case you can declare additional paths where `Spacemacs` can look for
contribution layers. This is done by setting the list
`dotspacemacs-configuration-layer-path` in your `~/.spacemacs`:
```elisp
(defvar dotspacemacs-configuration-layer-path '("~/.mycontribs/")
"List of additional paths where to look for configuration layers.
Paths must have a trailing slash (ie. `~/.mycontribs/')"
)
```
#### Themes Megapack example
This is a simple contribution layer listing a bunch of themes.