diff options
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 48 |
1 files changed, 48 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..3eede94 --- /dev/null +++ b/README.md | |||
@@ -0,0 +1,48 @@ | |||
1 | Here are my system configurations. There are many like them but these are mine. | ||
2 | |||
3 | |||
4 | # Installation | ||
5 | |||
6 | Clone this repo to `$XDG_CONFIG_HOME`, which in [profile/profile](https://github.com/duckwork/etc/blob/main/profile/profile) I’ve set to | ||
7 | `$HOME/etc`. See that file for other XDG directories I’ve set to non-standard | ||
8 | places. (Just in case something hard-codes `$XDG_CONFIG_HOME`, I also symlink | ||
9 | them in `bootstrap.sh`, which see below.) | ||
10 | |||
11 | Instead of GNU Stow or a Makefile, I use a short `bootstrap.sh` script that reads | ||
12 | `bootstrap.manifest`, a tab-separated file mapping repo paths to paths in `$HOME`. | ||
13 | It only contains files for programs that [aren’t XDG-compliant](https://wiki.archlinux.org/title/XDG_Base_Directory#Support), so it should stay | ||
14 | short. | ||
15 | |||
16 | Anyway, run `bootstrap.sh` in this directory and you should be set. | ||
17 | |||
18 | |||
19 | # Programs to install | ||
20 | |||
21 | |||
22 | ## Required | ||
23 | |||
24 | - **bash + readline:** I prefer this shell over others, since I don’t do anything | ||
25 | super wild in the terminal nowadays anyway | ||
26 | - **git:** Kind of required to do anything with this repo | ||
27 | - **keychain:** Manages `ssh-agent` | ||
28 | |||
29 | |||
30 | ## Extra | ||
31 | |||
32 | - **mbsync:** For mail. | ||
33 | |||
34 | |||
35 | # Notes | ||
36 | |||
37 | - My [emacs configuration is elsewhere](https://tildegit.org/acdw/emacs), but it goes in `$XDG_CONFIG_HOME` as well. | ||
38 | |||
39 | |||
40 | # License | ||
41 | |||
42 | Everyone is permitted to do whatever with this software, without limitation. | ||
43 | This software comes without any warranty whatsoever, but with two pieces of | ||
44 | advice: | ||
45 | |||
46 | - Don’t hurt yourself. | ||
47 | - Make good choices. | ||
48 | |||