Browse Source

Added Commentary

Samuel W. Flint 8 years ago
parent
commit
2d2863b330
1 changed files with 9 additions and 0 deletions
  1. 9 0
      buffer-layers.el

+ 9 - 0
buffer-layers.el

@@ -10,6 +10,15 @@
 
 ;;; Commentary:
 ;;
+;; This is Buffer Layers, a simple, layer-based buffer management system.
+;;
+;; It works by defining buffer layers using a fairly simple macro.  An example is as follows:
+;;
+;; (define-buffer-layer org
+;;   :files ("~/org/"
+;;           "~/org/main.org")
+;;   :buffer-to-select "main.org"
+;;   :run-on-apply ((my/find-current-notes-file)))
 
 
 ;;; Code: