aboutsummaryrefslogtreecommitdiff
path: root/README.org
diff options
context:
space:
mode:
authorAryadev Chavali <aryadev@aryadevchavali.com>2023-07-13 20:53:22 +0100
committerAryadev Chavali <aryadev@aryadevchavali.com>2023-07-13 20:53:22 +0100
commitf908d9e95666f468a8bfa4381b22265270cfd55f (patch)
tree95fc666432d4ab46afd6e5d7779e9fe6c1fb4ca7 /README.org
parent3d7940f13c8584022be86b01f46f8bc55b6bb1cd (diff)
downloaddotfiles-f908d9e95666f468a8bfa4381b22265270cfd55f.tar.gz
dotfiles-f908d9e95666f468a8bfa4381b22265270cfd55f.tar.bz2
dotfiles-f908d9e95666f468a8bfa4381b22265270cfd55f.zip
(*)~update README
Diffstat (limited to 'README.org')
-rw-r--r--README.org44
1 files changed, 26 insertions, 18 deletions
diff --git a/README.org b/README.org
index 8eab5cb..c1a7005 100644
--- a/README.org
+++ b/README.org
@@ -2,29 +2,37 @@
#+AUTHOR: Aryadev Chavali
#+DESCRIPTION: README for Dotfiles
-* Introduction
-My Dotfiles repository with configuration files for most of the
-applications I use on a daily basis.
-* Install
-Clone this into the =~/Dotfiles= directory. Install Emacs. Win.
+This repository contains most of my custom configurations for programs
+I use daily.
+* Install
+1) Clone this repository to =~/Dotfiles=
+2) Construct the following directories:
+ + =~/.local=
+ + =src=
+ + =bin=
+ + =lib=
+ + =share=
+ + =~/.config=
+ + =~/Downloads=
+ + =~/Code=
+ + =~/Media=
+ + =~/Projects=
+3) Install [[https://www.gnu.org/software/stow/][GNU/stow]]
+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
-installs just won't cut it. Therefore, to make it leverage more of
-the system I've created, we're going to use my build of Emacs.
+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:
#+begin_src sh
cd ~/.local/src;
-git clone git@git.aryadevchavali.com:/git/emacs.git;
+git clone git@git.aryadevchavali.com:/git/emacs.git emacs;
cd emacs;
-sh personal-install;
+sh personal-install; # Will configure, build and attempt to install
#+end_src
-** Currently used packages
-- XServer
-- vim
-- Shell
-- SystemD
-- Emacs
-- Mail
-- Neovim
-- ClangFormat
+