Browse Source

Added a README

Samuel W. Flint 7 years ago
parent
commit
98eaaea485
1 changed files with 12 additions and 0 deletions
  1. 12 0
      README.md

+ 12 - 0
README.md

@@ -0,0 +1,12 @@
+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:
+
+```elisp
+(define-buffer-layer org
+  :files ("~/org/"
+          "~/org/main.org")
+  :buffer-to-select "main.org"
+  :run-on-apply ((my/find-current-notes-file)))
+```
+