Add some intro text to init.org

1 files changed, 38 insertions, 0 deletions

diff --git a/.emacs.d/init.org b/.emacs.d/init.org
index d785448..4bb9715 100644
--- a/.emacs.d/init.org
+++ b/.emacs.d/init.org
@@ -5,6 +5,44 @@
 #+MACRO: key   @@html:<kbd>$1</kbd>@@@@ascii:`$1'@@
 #+HTML_HEAD: <link href="https://ryuslash.org/org.css" rel="stylesheet" type="text/css">
 
+* About this file
+
+  Inspired by such other projects as the literal Emacs init from [[http://sachac.github.io/.emacs.d/Sacha.html][Sacha
+  Chua]] and also from [[http://www.wisdomandwonder.com/wordpress/wp-content/uploads/2014/03/C3F.html][Grant Rettke]], here is my Emacs initialization
+  file.
+
+  *Note:* This is not my entire Emacs initialization file. It's a
+  work-in-progress. To keep on top of any changes to this file, or any
+  other part of my Emacs init, I recommend you follow [[http://code.ryuslash.org/dot/tom/emacs/][This project]]
+  ([[http://code.ryuslash.org/dot/tom/emacs/atom/?h=master][Atom feed]]), which is where I keep my configuration.
+
+** Preparation
+
+   I could use org-babel to load this file, but I don't like my
+   initialization file being dependent on too many things, especially
+   big things, and org is a big thing. It may be strange for you to
+   read this, as I have placed my entire Emacs configuration in an
+   org-mode file, but here are the make targets I use to tangle and
+   subsequently byte-compile my init file:
+
+   #+BEGIN_SRC makefile :tangle no
+     %.elc: %.el
+         emacs -Q -batch -eval "(byte-compile-file \"$<\")"
+
+     init.el: init.org
+         emacs -Q -batch -l "ob-tangle" -eval "(org-babel-tangle-file \"init.org\")
+   #+END_SRC
+
+   Executing the second target (either through make, or manually) will
+   get you my Emacs initialization file in plain Emacs Lisp.
+
+   *Note:* If you look at this file in it's org-mode form you will
+   notice that I actually tangle ~init.org~ into ~init2.el~. This is a
+   temporary measure so that I can gradually move my configuration
+   from my existing ~init.el~ file into ~init.org~ without much trouble.
+   Once I've emptied out my ~init.el~ I will instruct babel to tangle
+   into ~init.el~, this code already reflects that.
+
 * Use lexical binding
 
   For some of these functions lexical binding is a must.