From e8653d06289d2cd027574fd1b81370cf5add933d Mon Sep 17 00:00:00 2001 From: Henrik Lissner Date: Thu, 24 May 2018 22:21:00 +0200 Subject: [PATCH] feature/file-templates: revise doom module README.org file template --- .../file-templates/templates/org-mode/__doom-readme | 13 ++++++++----- 1 file changed, 8 insertions(+), 5 deletions(-) diff --git a/modules/feature/file-templates/templates/org-mode/__doom-readme b/modules/feature/file-templates/templates/org-mode/__doom-readme index 901c25faf..8a6f23a5d 100644 --- a/modules/feature/file-templates/templates/org-mode/__doom-readme +++ b/modules/feature/file-templates/templates/org-mode/__doom-readme @@ -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. -+ If possible, include a list of features -+ Include links to major plugins that the module uses, if applicable -+ Use links whenever you can -+ Mention dependencies on other modules here} ++ If possible, include a brief list of feature highlights here ++ Like code completion, syntax checking or available snippets ++ Include links to packages & external things where possible * Table of Contents :TOC: @@ -25,11 +24,15 @@ This module provides no flags. This module has no prereqisites. * 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 +How to configure this module, including common problems and how to address them. * Appendix ** 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 ++ Include a list of ways this module changes default behavior $0 \ No newline at end of file