diff options
| author | Max Bossing <info@maxbossing.de> | 2025-07-15 14:57:05 +0200 |
|---|---|---|
| committer | Max Bossing <info@maxbossing.de> | 2025-07-15 14:57:05 +0200 |
| commit | 9934bcddbc9d54db28dc4d34538107138d76c7ef (patch) | |
| tree | e964144a8c8af7555417558d274d0abcb5bc5ce1 | |
| parent | 2e511b258c339b28bd4caa1ff5922abc1da10447 (diff) | |
docs: Installation instructions
| -rw-r--r-- | README.md | 7 |
1 files changed, 7 insertions, 0 deletions
@@ -8,6 +8,13 @@ generally a bit _clunky_. `dots` is a machine-agnostic, fs-agnostic and structure-agnostic deployer for dotfiles stored in an arbitrary directory. Written in rust, it's :sparkles: _blazingly fast_ :sparkles: and easy to use. +## Installation + +To install `dots`, head over to [the releases page](https://github.com/maxbossing/dots/releases/latest) and choose the +appropriate option for your system. `dots` currently only supports linux, but in glibc and MUSL variants. + +To build from source, simply clone and run `cargo build --release`. + ## dots.toml At the core, `dots` just symlinks arbitrary files and directories as specified by a configuration file. By default, `dots` |