From ce3afd2a2a57184b9c99d35b22ce38bb469b7d55 Mon Sep 17 00:00:00 2001 From: Henrik Lissner Date: Thu, 16 Mar 2017 14:28:26 -0400 Subject: [PATCH] Update readmes --- README.md | 3 ++- modules/README.md | 17 +++++++++-------- modules/private/README.md | 13 +++++++++++++ 3 files changed, 24 insertions(+), 9 deletions(-) create mode 100644 modules/private/README.md diff --git a/README.md b/README.md index 0469de17b..59dacd7a3 100644 --- a/README.md +++ b/README.md @@ -77,7 +77,8 @@ To get a picture of what's in here, check out: * [Minimalistic diffs in the fringe][sc-diffs] with **[git-gutter-fringe]**. * A do-what-I-mean jump-to-definition implementation that tries its darnest to find the definition of what you're looking at. It tries - major-mode commands, **[dumb-jump]**, ctags, then **[counsel-ag]**. + major-mode commands, xref (experimental Emacs library) + **[dumb-jump]**, ctags (WIP), then **[counsel-ag]**. * Snippets and file-templates with **[yasnippet]**. * A smarter, perdier, Atom-inspired mode-line that includes: * evil-search/iedit/evil-substitute mode-line integration diff --git a/modules/README.md b/modules/README.md index 0a4d9c15a..c708a02d1 100644 --- a/modules/README.md +++ b/modules/README.md @@ -3,7 +3,7 @@ Modules are made up of three (optional) parts: + A `config.el` file, automatically loaded when the module is loaded - (through `@doom` or `@require`). It uses `@def-package` calls (thin + (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 @@ -13,15 +13,16 @@ Modules are made up of three (optional) parts: scanned by `doom/reload-autoloads` and lazily loaded. The convention for extra config files is to prefix them with a plus -(`+git.el`). These are not automatically loaded. +(`+git.el`). These must be manually loaded using `load!` from a +module's configuration. ## What modules aren't -Modules loosely take after Spacemacs' notion of layers, but are not -meant to be interchangeable. Their purpose is _almost_ purely +Modules loosely take after Spacemacs' notion of layers, but were not +meant to be as 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. +The only exception 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. diff --git a/modules/private/README.md b/modules/private/README.md new file mode 100644 index 000000000..3fc43e4ee --- /dev/null +++ b/modules/private/README.md @@ -0,0 +1,13 @@ +# Private modules + +Modules here are ignored by git and should contain personal settings +you don't want DOOM updates to interfere with (if that matters to +you). + +I include mine as a reference. However, keep in mind that it is +fiercely evil-mode-oriented. I apologize to non-evil users, but you +will likely want to rewrite +bindings.el entirely and delete ++commands.el. + +Fortunately, besides disabled the evil module, that should be all you +need to do to get an evil-less DOOM Emacs.