emenel/doomemacs
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

feature/file-templates: revise doom module README.org file template

Browse source
This commit is contained in:
Henrik Lissner 2018-05-24 22:21:00 +02:00
parent b806ff937c
commit e8653d0628
No known key found for this signature in database
GPG key ID: 5F6C0EA160557395
1 changed files with 8 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

13
modules/feature/file-templates/templates/org-mode/__doom-readme
View file

@ -11,10 +11,9 @@ ${2:A short summary about what this module does.}
${3:If necessary, include a longer description below it that goes into more detail. This may be as long as you like. ${3:If necessary, include a longer description below it that goes into more detail. This may be as long as you like.
+ If possible, include a list of features + If possible, include a brief list of feature highlights here
+ Include links to major plugins that the module uses, if applicable + Like code completion, syntax checking or available snippets
+ Use links whenever you can + Include links to packages & external things where possible
+ Mention dependencies on other modules here}
* Table of Contents :TOC: * Table of Contents :TOC:
@ -25,11 +24,15 @@ This module provides no flags.
This module has no prereqisites. This module has no prereqisites.
* Features * Features
A list of features, how to use them, and their dependencies. An in-depth list of features, how to use them, and their dependencies.
* Configuration * Configuration
How to configure this module, including common problems and how to address them.
* Appendix * Appendix
** Commands ** Commands
+ A list or table of public commands (and their keybinds) and functions that this module exposes.
+ A brief description of how to use them
** Hacks ** Hacks
+ Include a list of ways this module changes default behavior
$0 $0