aboutsummaryrefslogtreecommitdiff
path: root/README.org
blob: d8c29feb89e6214e13471e6200d4ffa6f8f76711 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
#+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]] (emacs, bash, rofi)
- [[https://depp.brause.cc/dotemacs.git][wasamasa]] (emacs)
- [[https://depp.brause.cc/dotemacs.git][John Wiegley]] (emacs)
- [[https://github.com/arkenfox][arkenfox]] (firefox)

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.

  Some configs require reading local configs e.g. =.bashrc= sourcing
  =.bashrc_local=.
- 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.
- The =firefox= directory :: "Init" files for firefox, including
  =user.js=

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.

For comments, bug reports or patches, please use the mailing list
[[https://lists.sr.ht/~ycp/gym][~ycp/gym@lists.sr.ht]].