commit 763be5117d15634a0dd2dc0eaa55c3d7fa901bf6
parent 8be03e409463853da99547276d1dcf79bf96371d
Author: Cem Keylan <cem@ckyln.com>
Date: Sun, 5 Jul 2020 21:13:15 +0300
add new README
Diffstat:
2 files changed, 26 insertions(+), 1 deletion(-)
diff --git a/.gitignore b/.gitignore
@@ -4,4 +4,4 @@
!init.org
!init.el
!.gitignore
-!README.org
+!README
diff --git a/README b/README
@@ -0,0 +1,25 @@
+cem's emacs configuration
+-------------------------
+
+This is my bloated Emacs configuration written in org-mode. The configuration is
+tangled from org-mode to emacs-lisp on initial startup. So both the code and the
+documentation can be found in 'init.org'.
+
+Obviously this is a pretty personalized configuration. It focuses on C, Shell,
+Go, and just a tiny bit of Python. Since I personally use emacsclient, I don't
+aim to keep the emacs startup fast. On my personal computer, I start emacs
+daemon when my user session starts, which takes around 10 seconds (unless I
+restart emacs, which takes a little less than a second), and I connect to the
+daemon with emacsclient, which takes no time.
+
+
+install
+-------
+
+In order to install, simply clone this repository to your home directory, and
+start emacs.
+
+ git clone git://git.ckyln.com/emacs.d ~/.emacs.d
+
+The initial launch will take a few minutes while emacs builds the packages in
+this configuration.
