diff options
Diffstat (limited to 'README.org')
| -rw-r--r-- | README.org | 35 |
1 files changed, 35 insertions, 0 deletions
diff --git a/README.org b/README.org new file mode 100644 index 0000000..45f7ec2 --- /dev/null +++ b/README.org @@ -0,0 +1,35 @@ +#+title: Yuchen Pei's dotfiles +#+author: Yuchen Pei +#+language: en + +Here you can find my dotfiles. The =emacs= and =misc= directories can +be deployed using GNU Stow: + +#+begin_src shell +stow -t ~ emacs +stow -t ~ misc +#+end_src + +Acknowledgement: configs in this repo is influenced by configs from +many people, including: + +- [[https://git.sr.ht/~protesilaos/dotfiles][Protesilaos Stavrou]] +- [[https://depp.brause.cc/dotemacs.git][wasamasa]] +- [[https://depp.brause.cc/dotemacs.git][John Wiegley]] + +The directories are organised as follows: + +- The =emacs= directory :: My emacs init files, including packages not + available on (Non)GNU ELPA mostly as submodules. See the + [[file:emacs/README.org][=README.org=]] therein. +- The =misc= directory :: All non-emacs configs that can be ~stow~'d + to the home directory, including for things like i3, rofi, bash, X11 + etc. +- The =manual= directory :: All things that requires more than just an + invocation of GNU Stow, including firefox extension. +- The =mariadb-server= directory :: dir local files for mariadb + development, to be moved to a separate repo. + +Unless otherwise specified, everything is licensed under the GNU +Affero General Public License, Version 3 or later. You may find a +license file in the root directory. |