add some documentation

[emacs] automatically load counsel after 1.5 seconds

diff --git a/README.md b/README.md
deleted file mode 100644 (file)
index 353de0d..0000000
--- a/README.md
+++ /dev/null
@@ -1,15 +0,0 @@
-dotfiles
-========
-
-Use [GNU Stow](http://www.gnu.org/software/stow/) to symlink the config for each
-application to their corresponding folder. For instance, `stow vim`.
-
-GTK Theme:
-
-- GTK2: [Greybird](https://github.com/shimmerproject/Greybird)
-- GTK3: [Minwaita](https://github.com/godlyranchdressing/Minwaita)
-
-*P.S.* do NOT stow `other`, as it's not meant to be copied/symlinked in the home
-folder. Some should be copied to a location in root, or just be run to perform
-setup. I should revisit the structure of `other` some time to make it consistent
-with the rest of repo.

diff --git a/README.org b/README.org
new file mode 100644 (file)
index 0000000..d837064
--- /dev/null
+++ b/README.org
@@ -0,0 +1,21 @@
+#+title: dotfiles
+
+This is my dotfiles repository; i.e. where I keep the configuration
+files of all the pieces of software I use.
+
+My GNU Emacs configuration is in [[file:init.org][init.org]], which is a literate Org
+mode file that gets tangled (i.e. exported) to =init.el= using
+=org-babel=. Emacs packages are installed and managed using [[https://github.com/emacscollective/borg][Borg]],
+which helps me have a fully reproducible setup.
+
+The configurations for all the other programs I use is located in
+[[file:rc.org][rc.org]]. Similar to my =init.org= file for Emacs, is also written in
+Org mode; and the configuration for each program is tangled to a file
+at its expected location on disk.
+
+Note: even though GitHub has a decent renderer for Org mode files, I
+/strongly/ suggest using Emacs itself for browsing through the org
+files.
+
+P.S. my previous =stow=-based setup along with my brief experiment
+with [[https://github.com/raxod502/straight.el][straight.el]] can be accessed from the =straight-exp= branch.

diff --git a/init.org b/init.org
index e2c87b3..e5149a3 100644 (file)
--- a/init.org
+++ b/init.org
@@ -22,6 +22,19 @@ to my init time; which is unacceptable for me: I use Emacs as my
 window manager (via EXWM) and coming from bspwm, I'm too used to
 having fast startup times.
 
 window manager (via EXWM) and coming from bspwm, I'm too used to
 having fast startup times.
 

+To use this config for your Emacs, first you need to clone this repo,
+then bootstrap Borg, tell Borg to retrieve package submodules, and
+byte-compiled the packages. Something along these lines should work:
+
+#+begin_src sh
+git clone https://github.com/aminb/dotfiles ~/.emacs.d
+cd ~/.emacs.d
+make bootstrap-borg
+make tangle-init
+make bootstrap
+make build
+#+end_src
+

 * Contents                                                   :toc_1:noexport:
 
 - [[#about][About]]
 * Contents                                                   :toc_1:noexport:
 
 - [[#about][About]]


@@ -545,6 +558,7 @@ There's no way I could top that, so I won't attempt to.
 
 #+begin_src emacs-lisp
 (use-package counsel
 
 #+begin_src emacs-lisp
 (use-package counsel

+  :defer 1.5

   :bind (([remap execute-extended-command] . counsel-M-x)
          ([remap find-file] . counsel-find-file)
          ("s-r"     . counsel-recentf)
   :bind (([remap execute-extended-command] . counsel-M-x)
          ([remap find-file] . counsel-find-file)
          ("s-r"     . counsel-recentf)