This repository has been archived on 2024-03-28. You can view files and clone it, but cannot push or open issues or pull requests.
dotfiles/readme.md

98 lines
3.6 KiB
Markdown
Raw Normal View History

2020-11-06 00:31:43 -06:00
# lytedev's dotfiles
2017-02-05 14:38:57 -06:00
2021-11-03 12:01:43 -05:00
My various configuration files. I can't recommend using them directly, just
take what you like.
2020-11-06 12:00:43 -06:00
2020-11-06 11:52:18 -06:00
[🖥️ Upstream][upstream] • [🐙 GitHub Mirror][github]
2020-11-06 11:59:11 -06:00
![Battlestation][battlestation-photo]
2020-11-06 11:16:29 -06:00
![Desktop Screenshot][desktop-screenshot]
2021-11-03 13:24:05 -05:00
# Repo Structure
My dotfiles are composed together by layering "environments" since I want my dotfiles to be flexible across servers, laptops, desktops, and even my phone (via Termux).
lytedev-dotfiles
|- common --- common to all hosts and operating systems
| |- bin ------- programs or scripts useful to all hosts/OSs
| |- data ------ shared storage for certain scripts
| `- {app...} -- configuration related to {app}
|- host ----- specific to specific hosts or types of hosts
| |- desktop --- for desktop-class machines
| |- headless -- for server-class machines with no display/GUI
| `- laptop ---- for portable, battery-having machines
`- os ------- specific to operating systems
|- linux -----
| |- desktop ------ for desktop-class machines
| |- headless ----- for server-class machines with no display/GUI
| |- bin ---------- programs/scripts useful to linux machines
| |- {distro...} -- configuration related to {distro}
| `- {app...} ----- linux-specific configuration related to {app}
`- macos ----- for those stupid macbooks work tries to make you use
Any environment should be able to extend the configuration of any application
in some unique way. This isn't possible with all applications, of course, since
some programs do not make it easy (or possible) to include multiple
configuration files or to extend a single file by having it include others via
globs or some other mechanism.
One example of doing this well is with fish:
for s in $ENV_PATH/*/config.d.fish; source $s (dirname $s); end
This way, if any environment (a dir in $ENV_PATH) has a `config.f.fish` script
inside, it will be sourced by the main configuration file.
Likewise, some setup only happens in certain environments via the
`dotfiles-setup.d.fish` script.
2021-11-03 12:01:43 -05:00
# Basic Setup
2021-03-06 22:24:09 -06:00
2021-11-03 12:18:12 -05:00
curl -Ss https://lyte.dev/df.sh | sh
2021-11-03 12:01:43 -05:00
## I don't like `curl ... | sh`
Clone the repo:
git clone https://git.lyte.dev/lytedev/dotfiles.git "$HOME/.config/lytedev-dotfiles"
Inspect and run the common (no macOS- or Linux-specific configuration) setup
`fish` script:
$EDITOR "$HOME/.config/lytedev-dotfiles/common/bin/dotfiles-setup"
"$HOME/.config/lytedev-dotfiles/common/bin/dotfiles-setup"
## Post-Setup
2021-11-03 12:01:43 -05:00
You will want to symlink relevant environment layers into the `$ENV_PATH` in
order to have your OS-specific applications be configured and common
applications configured for the host OS.
2017-02-05 14:38:57 -06:00
2021-11-03 12:52:33 -05:00
There's a handy `fzf`-based script that makes this super easy (note that you
can select multiple environments with TAB):
2021-09-24 13:06:43 -05:00
2021-11-03 12:52:33 -05:00
dotfiles-link-environments
2021-11-03 12:01:43 -05:00
You can also list the possible environments:
cat $DOTFILES_PATH/common/envs
2021-11-03 12:52:33 -05:00
And then link them yourself (note that environments must be in $ENV_PATH and
cannot be nested, so replacing slashes with dashes is a nice way to show what's
going on):
2021-11-03 12:01:43 -05:00
ln -s (pwd)/os/linux $ENV_PATH/os-linux
ln -s (pwd)/os/linux/arch $ENV_PATH/os-linux-arch
ln -s (pwd)/host/laptop $ENV_PATH/host-laptop
ln -s (pwd)/host/laptop/third $ENV_PATH/os-laptop-third
2021-11-03 12:18:12 -05:00
# etc...
2021-11-03 12:01:43 -05:00
And run setup again once you've finished linking all related environments:
dotfiles-setup
2019-03-19 10:58:12 -05:00
[upstream]: https://git.faceless.lytedev.io/lytedev/dotfiles
[github]: https://github.com/lytedev/dotfiles
[desktop-screenshot]: https://files.lyte.dev/unix/desktop-screenshot.png
2020-11-06 11:59:39 -06:00
[battlestation-photo]: https://files.lyte.dev/unix/battlestation.jpg