From 9934bcddbc9d54db28dc4d34538107138d76c7ef Mon Sep 17 00:00:00 2001 From: Max Bossing Date: Tue, 15 Jul 2025 14:57:05 +0200 Subject: docs: Installation instructions --- README.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/README.md b/README.md index 8cadb89..12baa5c 100644 --- a/README.md +++ b/README.md @@ -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` -- cgit v1.0