repositories / dotfiles

dotfiles

bugabingas dorkfiles

owned by bugabinga

docs: clean up README

21b8ea155c76395ff952728b1252211eafd64406

Oliver Jan Krylow <olver@bugabinga.net> ·

unsigned

Browse filesCompare with HEAD

Changed files (2)

.vscode/settings.json

Modified
2 2 "cSpell.words": [
3 3 "bootstripper",
4 + "chezmoi",
4 5 "dorkfile",
5 6 "dorkfiles",
6 7 "tresor"

README.md

Modified
7 7 1. Install git
8 8 1. Install a JDK
9 -1. git clone git@github.com:bugabinga/dotfiles
9 +1. `git clone git@github.com:bugabinga/dotfiles`
10 10 1. `cd dotfiles`
11 11 1. `java bootstripper.java`
17 17 Initial setup on windows is a little more sophisticated, because I am used to a developers environment.
19 -1. Enable Devoloper Mode, so that it is allowed to make symlinks without admin permissions.
19 +1. Enable Developer Mode, so that it is allowed to make symlinks without admin permissions.
20 20 1. Install Build Tools with C++ Option (for Rust and cargo tools)
21 21 1. Install Git without internal SSH
22 22 1. Start ssh-agent service
30 30 The current state is a compromise reached after some experimentation.
31 31 - editing and applying configs is "natural"
32 32 Natural in this context is to mean: as if there was no dotfiles repository used for sharing.
33 - This is achieved by symlinking the files from the dotfiles repository into their normal locations.
34 - So when it comes time to edit a confg file, you can stay blissfully unaware of the dotfiles repository.
33 + This is achieved by sym-linking the files from the dotfiles repository into their normal locations.
34 + So when it comes time to edit a config file, you can stay blissfully unaware of the dotfiles repository.
36 36 ## handling per host differences
40 40 ### differing locations of config files
42 42 For example, [NeoVim] stores its configuration at `~/.config/nvim` in Linux and at `~/AppData/Roaming/nvim` in Windows.
43 -In order to handle theses differences each host gets its own symlink file wiht the naming pattern `(hostname).symlinks`.
43 +In order to handle theses differences each host gets its own symlink file with the naming pattern `(hostname).symlinks`.
44 44 The format of this file is:
45 -```
46 +```txt
46 47 path to configuration file/directory relative to dotfiles root
47 48 absolute path of symlink on host
49 51 Each symlink path pair is to be delimited by a newline.
50 52 Example:
51 -```
54 +```txt
52 55 neovim
53 56 ~/.config/nvim
55 58 foo/bar.conf
56 59 ~/.config/foobar.conf
58 62 This file will be parsed by [bootstripper] in order to create those symlinks.
60 -### differing values in configration files
64 +### differing values in configuration files
62 -Most often, these come down to different paths of stuff, that get refered to in config files.
66 +Most often, these come down to different paths of stuff, that get referred to in config files.
63 67 For example, [topgrade], an abstraction over a bunch of package managers and updaters, might want to know the location of your git repositories, so it can pull them for you.
64 68 Some programs, e.g. [NeoVim], have rich configuration languages that are powerful enough for you to resolve those differences with conditionals.
65 69 However some programs, e.g. [topgrade], offer only declarative configuration languages, which make it impossible to resolve this problem in the config.
73 77 That means, that config files are completely independent per host, and as such some duplication of configuration occurs.
74 78 A tradeoff well worth it in my opinion.
76 -## secrets
80 +## WIP:secrets
78 82 Secrets are encrypted and saved as file into the `tresor` folder.
79 83 The name of these file is a random UUID, which I map to their original purpose somewhere else.
93 97 - dotfiles managers (e.g. [chezmoi])
94 98 > too much work
95 99 - writing a bootstrap/installer with [cosmopolitan]
96 - > extremely cool tech. unfortunatelly I am not a C programmer so I struggled a lot.
100 + > extremely cool tech. unfortunately I am not a C programmer so I struggled a lot.
97 101 > also, the resulting binary rewrites itself on first run. How do I keep a file version controlled that is allowed to change on first use, but should not result in a new modification...?
98 102 > furthermore, managing the [cosmopolitan] toolchain for windows made extra work.
99 103 - use POSIX shell for Unix, use PowerShell for Windows
117 121 [PowerShell Core]: https://github.com/PowerShell/PowerShell
118 122 [PowerShell Windows]: https://de.wikipedia.org/wiki/PowerShell
119 123 [OpenBSD]: https://www.openbsd.org/
124 +[cosmopolitan]: https://github.com/jart/cosmopolitan