From 5a53b6a5718e0e16ec5cac40a30a1e7164a9bb6c Mon Sep 17 00:00:00 2001 From: Case Duckworth Date: Wed, 15 Jun 2022 15:34:40 -0500 Subject: Move readme.org -> readme.md --- README.md | 48 ++++++++++++++++++++++++++++++++++++++++++++++++ README.org | 44 -------------------------------------------- 2 files changed, 48 insertions(+), 44 deletions(-) create mode 100644 README.md delete mode 100644 README.org diff --git a/README.md b/README.md new file mode 100644 index 0000000..3eede94 --- /dev/null +++ b/README.md @@ -0,0 +1,48 @@ +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://tildegit.org/acdw/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. + diff --git a/README.org b/README.org deleted file mode 100644 index dd80eff..0000000 --- a/README.org +++ /dev/null @@ -1,44 +0,0 @@ -#+TITLE: My configurations -#+AUTHOR: Case Duckworth - -Here are my system configurations. There are many like them but these are mine. - -* Installation - -Clone this repo to ~$XDG_CONFIG_HOME~, which in [[https://github.com/duckwork/etc/blob/main/profile/profile][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 [[https://wiki.archlinux.org/title/XDG_Base_Directory#Support][aren't XDG-compliant]], 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 [[https://tildegit.org/acdw/emacs][emacs configuration is elsewhere]], 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. -- cgit 1.4.1-21-gabe81