Update READMEs
This commit is contained in:
parent
e7bbd06e02
commit
347af62898
2 changed files with 50 additions and 58 deletions
|
@ -1,17 +1,27 @@
|
|||
# Modules
|
||||
|
||||
Though the structure of these modules loosely take after Spacemacs'
|
||||
notion of layers, they are not meant to be interchangeable. Their
|
||||
purpose is _almost_ purely organizational.
|
||||
Modules are made up of three (optional) parts:
|
||||
|
||||
The structure of a module is as follows (all files are optional):
|
||||
+ A `config.el` file, automatically loaded when the module is loaded
|
||||
(through `@doom` or `@require`). It uses `@def-package` calls (thin
|
||||
wrappers around `use-package`) to configure packages.
|
||||
+ A `packages.el` file filled with `@package` and `@depends-on`
|
||||
declarations. These are purely declarative macros. They populate
|
||||
`doom-packages` and `doom-modules` for the package management
|
||||
system.
|
||||
+ Either an `autoload.el` file or `autoload/*.el` files, which are
|
||||
scanned by `doom/reload-autoloads` and lazily loaded.
|
||||
|
||||
```bash
|
||||
config.el # loaded when module is enabled
|
||||
packages.el # loaded lazily by DOOM package management
|
||||
+*.el # extra config files (not automatically loaded)
|
||||
The convention for extra config files is to prefix them with a plus
|
||||
(`+git.el`). These are not automatically loaded.
|
||||
|
||||
# lazy-loaded functions
|
||||
autoload.el
|
||||
autoload/*.el
|
||||
```
|
||||
## What modules aren't
|
||||
|
||||
Modules loosely take after Spacemacs' notion of layers, but are not
|
||||
meant to be interchangeable. Their purpose is _almost_ purely
|
||||
organizational.
|
||||
|
||||
The only exception to this are completion modules. Other modules make
|
||||
no assumptions about which completion modules are enabled. If company
|
||||
isn't installed, company plugins will silently refuse to install, and
|
||||
their respective `@def-package` blocks will be ignored.
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue