aboutsummaryrefslogtreecommitdiff
path: root/README.org
diff options
context:
space:
mode:
authorAryadev Chavali <aryadev@aryadevchavali.com>2023-10-15 00:12:22 +0100
committerAryadev Chavali <aryadev@aryadevchavali.com>2023-10-15 00:12:22 +0100
commitbb84b70dd9994ffb290edb7d831f7eb78e2b3a0d (patch)
tree08a053d9f2dd8c4b0004d63b87e6cec2f843eef3 /README.org
parentda47ceb8987429c64c79cc361cea877201c32e7b (diff)
downloaddotfiles-bb84b70dd9994ffb290edb7d831f7eb78e2b3a0d.tar.gz
dotfiles-bb84b70dd9994ffb290edb7d831f7eb78e2b3a0d.tar.bz2
dotfiles-bb84b70dd9994ffb290edb7d831f7eb78e2b3a0d.zip
Update README
Diffstat (limited to 'README.org')
-rw-r--r--README.org19
1 files changed, 11 insertions, 8 deletions
diff --git a/README.org b/README.org
index c1a7005..5481413 100644
--- a/README.org
+++ b/README.org
@@ -2,10 +2,10 @@
#+AUTHOR: Aryadev Chavali
#+DESCRIPTION: README for Dotfiles
-This repository contains most of my custom configurations for programs
+This repository contains all of my custom configurations for programs
I use daily.
-* Install
+* Setup and installation procedure
1) Clone this repository to =~/Dotfiles=
2) Construct the following directories:
+ =~/.local=
@@ -22,16 +22,19 @@ I use daily.
4) Pick and choose what configurations you want
+ To install a module use ~stow <module>~
+ To remove a module use ~stow -D <module>~
-** Installing Emacs
-I like a specific set of flags on my Emacs install. Prepackaged
+* Installing Emacs
+I like a specific set of flags on my Emacs install, and my
+configuration kind of depends on them existing as well. Prepackaged
installs just won't cut it. So I'd highly recommend cloning and
-building my personal [[https://git.aryadevchavali.com/emacs][Emacs
-repo]] (currently =v28.1=). Or, if you're lazy, just run the
-following:
+building my personal
+[[https://github.com/oreodave/emacs-29-custom][Emacs repo]] (currently
+=v29=).
+
+Or just run the following lines:
#+begin_src sh
cd ~/.local/src;
-git clone git@git.aryadevchavali.com:/git/emacs.git emacs;
+git clone git@github.com:oreodave/emacs-29-custom emacs;
cd emacs;
sh personal-install; # Will configure, build and attempt to install
#+end_src