about summary refs log tree commit diff stats
path: root/README.md
blob: 878a972901f18f35f04759038597616b35ea692b (plain)
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
Here are my system configurations.  There are many like them but these are mine.

# Installation

Clone this repo to `$XDG_CONFIG_HOME`, which in [profile/profile](https://github.com/duckwork/etc/blob/main/profile/profile) I’ve set to
`$HOME/etc`.  See that file for other XDG directories I’ve set to non-standard
places.  (Just in case something hard-codes `$XDG_CONFIG_HOME`, I also symlink
them in `bootstrap.sh`, which see below.)

Instead of GNU Stow or a Makefile, I use a short `bootstrap.sh` script that reads
`bootstrap.manifest`, a tab-separated file mapping repo paths to paths in `$HOME`.
It only contains files for programs that [aren’t XDG-compliant](https://wiki.archlinux.org/title/XDG_Base_Directory#Support), so it should stay
short.

Anyway, run `bootstrap.sh` in this directory and you should be set.

# Programs to install

## Required

-   **bash + readline:** I prefer this shell over others, since I don’t do anything
    super wild in the terminal nowadays anyway
-   **git:** Kind of required to do anything with this repo
-   **keychain:** Manages `ssh-agent`

## Extra

-   **mbsync:** For mail.

# Notes

-   My [emacs configuration is elsewhere](https://git.acdw.net/emacs), but it goes in `$XDG_CONFIG_HOME` as well.

# License

Everyone is permitted to do whatever with this software, without limitation.
This software comes without any warranty whatsoever, but with two pieces of
advice:

-   Don’t hurt yourself.
-   Make good choices.