aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMax Bossing <info@maxbossing.de>2025-08-12 15:47:49 +0200
committerMax Bossing <info@maxbossing.de>2025-08-12 15:47:49 +0200
commit170ca58585dff48d8bd4d0f0a3b78e6c44ed2959 (patch)
tree8a099858852e5aaf231547d30aeed7cf806995fb
parent991c272423d8fa41c9dd21169ce0c3e9979f1c64 (diff)
docs: refactored README
-rw-r--r--README.md21
1 files changed, 15 insertions, 6 deletions
diff --git a/README.md b/README.md
index 0d1eeba..60e8fbc 100644
--- a/README.md
+++ b/README.md
@@ -1,15 +1,24 @@
-These are my personal config files.
+# Dotfiles
+
+These are my personal config files.
## Usage
-I use Fedora Workstation as my OS and Hyprland as my desktop of choice. For that I use [JaKooLit's Hyprland script](https://github.com/JaKooLit/Fedora-Hyprland/) script and then deploy my own dotfiles over it. Packages I install additionally are in `pkg.dnf`, `pkg.flatpak` and `pkg.cargo` respectively.
+I use Fedora Workstation as my OS and Hyprland as my desktop of choice. For
+that I use [JaKooLit's Hyprland script](https://github.com/JaKooLit/Fedora-Hyprland/)
+script and then deploy my own dotfiles over it. Packages I install additionally
+are in `pkg.dnf`, `pkg.flatpak` and `pkg.cargo` respectively.
I manage my configs with [`dots`](https://github.com/maxbossing/dots).
-`dots.toml`: Common dots for all devices
-`hestia.dots.toml`: My Workstation
-`hermes.dots.toml`: My Laptop
+> [!INFO]
+> I use hostname-based deployment for some configs with `dots`, so this will
+> probably not work out-of-the-box for you. You can circumvent that using the
+> `--no-hostname-check` cli option, but that comes with it's own caveats
+> (namely that things will get linked over each other)!
## License
-[MIT](LICENSE)
+With the exception of the base configuration of [LazyVim](https://lazyvim.org),
+which is licensed under [Apache 2.0](nvim/LICENSE), all files are
+[MIT](LICENSE)-licensed.