[elpa] externals/gcmh c1bc27a 06/32: Add readme

[Andrea Corallo]

branch: externals/gcmh
commit c1bc27aead05fda40bfe5d2959d29ccbcb7d92fd
Author: Andrea Corallo <andrea_corallo@yahoo.it>
Commit: Andrea Corallo <andrea_corallo@yahoo.it>

    Add readme
---
 README.org | 22 ++++++++++++++++++++++
 1 file changed, 22 insertions(+)

diff --git a/README.org b/README.org
new file mode 100644
index 0000000..e522e55
--- /dev/null
+++ b/README.org
@@ -0,0 +1,22 @@
+* GCMH - the Garbage Collector Magic Hack
+
+  Enforce a sneaky Garbage Collection strategy to minimize GC interference with
+  the activity.
+  During normal use a high GC threshold is set.
+  When idling GC is immediately triggered and a low threshold is set.
+  A more detailed explanation of the rationale behind this can be found at:
+
+  [[http://akrl.sdf.org/]]
+
+** Usage
+
+   Add into your .emacs
+
+   #+BEGIN_SRC
+(add-to-list 'load-path "path-to-gcmh-here")
+(require 'gcmh)
+(gcmh-mode 1)
+   #+END_SRC
+
+   If this is done at the beginning of your .emacs start-up time should
+   also benefit form it.