about summary refs log tree commit diff stats
diff options
context:
space:
mode:
-rw-r--r--README.md48
-rw-r--r--README.org44
2 files changed, 48 insertions, 44 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 @@
1Here are my system configurations. There are many like them but these are mine.
2
3
4# Installation
5
6Clone 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
8places. (Just in case something hard-codes `$XDG_CONFIG_HOME`, I also symlink
9them in `bootstrap.sh`, which see below.)
10
11Instead 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`.
13It only contains files for programs that [aren’t XDG-compliant](https://wiki.archlinux.org/title/XDG_Base_Directory#Support), so it should stay
14short.
15
16Anyway, 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
42Everyone is permitted to do whatever with this software, without limitation.
43This software comes without any warranty whatsoever, but with two pieces of
44advice:
45
46- Don’t hurt yourself.
47- Make good choices.
48
diff --git a/README.org b/README.org deleted file mode 100644 index dd80eff..0000000 --- a/README.org +++ /dev/null
@@ -1,44 +0,0 @@
1#+TITLE: My configurations
2#+AUTHOR: Case Duckworth
3
4Here are my system configurations. There are many like them but these are mine.
5
6* Installation
7
8Clone this repo to ~$XDG_CONFIG_HOME~, which in [[https://github.com/duckwork/etc/blob/main/profile/profile][profile/profile]] I've set to
9~$HOME/etc~. See that file for other XDG directories I've set to non-standard
10places. (Just in case something hard-codes ~$XDG_CONFIG_HOME~, I also symlink
11them in =bootstrap.sh=, which see below.)
12
13Instead of GNU Stow or a Makefile, I use a short =bootstrap.sh= script that reads
14=bootstrap.manifest=, a tab-separated file mapping repo paths to paths in ~$HOME~.
15It only contains files for programs that [[https://wiki.archlinux.org/title/XDG_Base_Directory#Support][aren't XDG-compliant]], so it should stay
16short.
17
18Anyway, run =bootstrap.sh= in this directory and you should be set.
19
20* Programs to install
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** Extra
30
31- mbsync :: For mail.
32
33* Notes
34
35- My [[https://tildegit.org/acdw/emacs][emacs configuration is elsewhere]], but it goes in ~$XDG_CONFIG_HOME~ as well.
36
37* License
38
39Everyone is permitted to do whatever with this software, without limitation.
40This software comes without any warranty whatsoever, but with two pieces of
41advice:
42
43- Don't hurt yourself.
44- Make good choices.