diff --git a/README.md b/README.md index 64cf394..118fc97 100644 --- a/README.md +++ b/README.md @@ -39,7 +39,17 @@ You can also enable it with a buffer-local variable by adding this as the first line of a config file: # -*-config-general-*- - + +### Usage + +Edit your config file as usual. Use tab for completion of +values and variables. Use C-c C-t to toggle flags (like +true to false). Use C-c C-= on a region to automatically +align on the `=` character. Use C-c C-/ to breakup a region +with long lines into shorter ones using backslash notation. Use +C-return to visit an included file or (when not on a link) +insert a new line below the current one, indent and move point there. + ### Customize You can customize the mode with: diff --git a/config-general-mode.el b/config-general-mode.el index d0b95a9..b704d2a 100644 --- a/config-general-mode.el +++ b/config-general-mode.el @@ -60,7 +60,17 @@ ;; the first line of a config file: ;; # -*-config-general-*- - + +;;;; Usage + +;; Edit your config file as usual. Use `' for completion of +;; values and variables. Use `C-c C-t' to toggle flags (like true to +;; false). Use `C-c C-=' on a region to automatically align on the `=` +;; character. Use `C-c C-/' to breakup a region with long lines into +;; shorter ones using backslash notation. Use `' to visit +;; an included file or (when not on a link) insert a new line below +;; the current one, indent and move point there. + ;;;; Customize ;; You can customize the mode with: