Add 'packages/aggressive-indent/' from commit '72796c652f0eb29902c3d95b7a5411757606b074'

[gnu-emacs-elpa] / packages / aggressive-indent / README.md

diff --git a/packages/aggressive-indent/README.md b/packages/aggressive-indent/README.md
new file mode 100644 (file)
index 0000000..8abb380
--- /dev/null
+++ b/packages/aggressive-indent/README.md
@@ -0,0 +1,64 @@
+aggressive-indent-mode
+======================
+(_[Wanna say thank you?](https://gratipay.com/Malabarba/)_)
+
+`electric-indent-mode` is enough to keep your code nicely aligned when
+all you do is type. However, once you start shifting blocks around,
+transposing lines, or slurping and barfing sexps, indentation is bound
+to go wrong.
+
+**`aggressive-indent-mode`** is a minor mode that keeps your code **always**
+indented. It reindents after every command, making it more reliable
+than `electric-indent-mode`.
+
+### Demonstration ###
+
+- An example of Lisp mode (Emacs Lisp):
+![Lisp Code Example](lisp-example.gif)
+
+- An example of non-Lisp mode (C):
+![C Code Example](c-example.gif)
+
+### Instructions ###
+
+This package is available fom Melpa, you may install it by calling
+
+    M-x package-install RET aggressive-indent
+
+Then activate it with
+
+    (add-hook 'emacs-lisp-mode-hook #'aggressive-indent-mode)
+    (add-hook 'css-mode-hook #'aggressive-indent-mode)
+
+You can use this hook on any mode you want, `aggressive-indent` is not
+exclusive to emacs-lisp code. In fact, if you want to turn it on for
+every programming mode, you can do something like:
+
+    (global-aggressive-indent-mode 1)
+    (add-to-list 'aggressive-indent-excluded-modes 'html-mode)
+
+#### Manual Installation ####
+
+If you don't want to install from Melpa, you can download it manually,
+place it in your `load-path` along with its two dependencies:
+
+- [Names](https://github.com/Bruce-Connor/names/)
+- and `cl-lib` (which you should already have if your `emacs-version` is at least 24.3).
+
+Then require it with:
+
+    (require 'aggressive-indent)
+
+### Customization ###
+
+The variable `aggressive-indent-dont-indent-if` lets you customize
+when you **don't** want indentation to happen.
+For instance, if you think it's annoying that lines jump around in
+`c++-mode` because you haven't typed the `;` yet, you could add the
+following clause:
+
+    (add-to-list
+     'aggressive-indent-dont-indent-if
+     '(and (derived-mode-p 'c++-mode)
+           (null (string-match "\\([;{}]\\|\\b\\(if\\|for\\|while\\)\\b\\)"
+                               (thing-at-point 'line)))))