diff --git a/README.md b/README.md index 85f21db..0b523f9 100644 --- a/README.md +++ b/README.md @@ -1,59 +1,58 @@ -## config-general-mode +# config-general-mode - Emacs major editing mode for Config::General config files. -Emacs major editing mode for Config::General config files. - -### Screenshot +## Screenshot ![demo](https://raw.githubusercontent.com/TLINDEN/config-general-mode/master/config-general-screenshot.png) -### Introduction -[Config::General](http://search.cpan.org/dist/Config-General/) is a -Perl module for parsing config files with some enhanced -features. [config-general-mode](https://github.com/TLINDEN/config-general-mode) -makes it easier to edit such config files with emacs. +## Introduction + +[Config::General](http://search.cpan.org/dist/Config-General/) is a +Perl module for parsing config files with some enhanced +features. `config-general-mode` makes it easier to edit such config +files with Emacs. It is based on `conf-mode` with the following features: - good syntax highlighting for config files -- completion support with tab (using `dabbrev`) -- imenu support for `` +- completion support with TAB (using `dabbrev`) +- imenu support for - electric paring mode (for quotes, parens, etc) enabled - automatic indenting -- jump to include file with return +- jump to include file with C-return -### Installation +## Installation To use, save config-general-mode.el to a directory in your load-path. Add something like this to your config: - (require 'config-general-mode) - (add-to-list 'auto-mode-alist '("\\.conf$" . config-general-mode)) + (require 'config-general-mode) + (add-to-list 'auto-mode-alist '("\\.conf$" . config-general-mode)) or load it manually, when needed: M-x config-general-mode - + You can also enable it with a buffer-local variable by adding this as the first line of a config file: # -*-config-general-*- -### Usage +## 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. -Use C-k to delete lines, including continuation lines or -whole blocks. Use C-c C-j to jump to a block definition -(same as using `imenu' with the mouse). +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. Use C-k to delete +lines, including continuation lines or whole blocks. Use C-c C-j +to jump to a block definition (same as using `imenu` with the +mouse). -### Customize +## Customize You can customize the mode with: @@ -63,15 +62,15 @@ You can also use hooks to config-general mode as a way to modify or enhance its behavior. The following hooks are available: config-general-mode-hook - + For example: - (add-hook 'config-general-mode-hook 'electric-indent-mode) + (add-hook 'config-general-mode-hook 'electric-indent-mode) -### Meta +## Meta -Copyright (C) 2017, T.v.Dein +Copyright (C) 2017, T.v.Dein This file is NOT part of Emacs. @@ -91,7 +90,7 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA - Version: 0.01 - - Author: T.v.Dein + - Author: T.v.Dein - Keywords: config file editing - URL: https://github.com/tlinden/config-general-mode - License: GNU General Public License >= 2