Commit 6db866b97bfb

Vincent Demeester <vincent@sbr.pm>
2019-01-13 16:01:42
Update README.org ๐Ÿ“–
Signed-off-by: Vincent Demeester <vincent@sbr.pm>
1 parent 423a9b4
Changed files (1)
README.org
@@ -1,2 +1,32 @@
-* My emacs configuration
+#+TITLE: vdemeester's .emacs.d
+
+#+BEGIN_QUOTE
+My emacs setup is tested to work only with emacs 25.1 and newer versions. If you are on
+older versions, I would recommend that you upgrade to the [[https://www.gnu.org/software/emacs/download.html][latest available stable version]].
+#+END_QUOTE
+
+* Few notes
+
+- This works best in =NixOS=, coupled with my [[https://github.com/vdemeester/home][=home=]] repository (especially with my
+  [[https://github.com/vdemeester/home/blob/master/modules/profiles/emacs.nix][emacs.nix]] file).
+- Almost all setup files have setup done as per my personal tastes and needs.
+- If you want to change the default theme, font size, etc, you would want to edit
+  =setup-files/setup-style.el=
+
+* Key points
+
+- Use of my minor mode =vde-mode= to enable my custom key-bindings. Doing so allows me to
+  force override my bindings in all major and minor modes. If I ever need to try out the
+  default emacs bindings, I can simply disable =vde-mode= by doing =M-x vde-mode=. /It
+  is enabled globally by default./
+- Use of =use-package= in load all packages for faster load times.
+- Use of =bind-keys= allows me to review my custom bindings in a single buffer by doing
+  =M-x describe-personal-keybindings=.
+- Certain packages will be loaded only if you have the associated applications installed.
+
+* Feedback
+
+Use at your own risk, but I am definitely looking forward to suggestions, corrections.
+
+Thanks!