Add more comments to the main configuration file

1 files changed, 19 insertions, 8 deletions

diff --git a/emacs/loader.org b/emacs/loader.org
index cafefb7..97744da 100644
--- a/emacs/loader.org
+++ b/emacs/loader.org
@@ -3,19 +3,22 @@
 #+AUTHOR: Yann Herklotz Grave
 
 * Introduction
-This is my GNU Emacs Configuration. It has support for many programming
-languages such as C++, Haskell and Clojure. It is written in a literate style
-using orgmode tangling to generate the actual configuration file. This can be
-done by adding the following line to the ~init.el~ file.
+This is my GNU Emacs Configuration.
+
+It is written in a literate style using orgmode tangling to generate the actual
+configuration file. This can be done by adding the following line to the
+~init.el~ file.
 
 #+BEGIN_SRC
   (setq init-dir (file-name-directory (or load-file-name (buffer-file-name))))
   (org-babel-load-file (expand-file-name "loader.org" init-dir))
 #+END_SRC
 
-It also supports academic writing with org mode using the amazing [[https://github.com/jkitchin/org-ref][org-ref]]
-package to add citations to the LaTeX output. The configuration for that can be
-found in the [[#Writing][Writing]] section.
+It has support for many programming languages such as C++, Haskell and
+Clojure. The configurations for the different languages can be found in the
+[[#Programming][Programming]] section. It also supports academic writing with org mode using the
+amazing [[https://github.com/jkitchin/org-ref][org-ref]] package to add citations to the LaTeX output. The configuration
+for that can be found in the [[#Writing][Writing]] section.
 
 #+BEGIN_SRC emacs-lisp
   (setq user-full-name "Yann Herklotz")
@@ -27,7 +30,9 @@ found in the [[#Writing][Writing]] section.
 
 * Setup
 
-Set path so that it picks up some executables that I use
+Set path so that it picks up some executables that I use. This is done because
+when emacs is started as a server, the PATH is not set correctly, so it has to
+be manually set inside emacs.
 
 #+BEGIN_SRC emacs-lisp
   (setenv "PATH"
@@ -41,6 +46,12 @@ Set path so that it picks up some executables that I use
 #+RESULTS:
 : /home/yannherklotz/.local/bin:/home/yannherklotz/.yarn/bin:/usr/bin/vendor_perl:/home/yannherklotz/.local/bin:/home/yannherklotz/.yarn/bin:/usr/local/sbin:/usr/local/bin:/usr/bin
 
+Define a function to load a user file whenever I want to add configurations that
+are not pushed as part of this configuration file. This includes a private file
+containing email configurations for [[https://www.emacswiki.org/emacs/mu4e][mu4e]]. In this case, ~user-init-dir~ is used
+to find the current init directory that Emacs is using and ~load-user-file~ can
+be used to load any file in that directory.
+
 #+BEGIN_SRC emacs-lisp
   (defconst user-init-dir
     (cond ((boundp 'user-emacs-directory)