Update README

This commit is contained in:
2024-11-10 16:07:58 +01:00
parent 89ae314939
commit 4ec1268b2e

View File

@@ -1,27 +1,45 @@
# dotfiles
My configuration files.
My configuration files for my systems. Uses Ansible for local configuration.
# Installation
## Supported OS
Only Arch Linux is supported
## Bootstrapping
Bootstrapping is specific to the exact machine that is installed. See
`_machines/` for machine-specific configuration, and `install_scripts/` for the
machine install scripts.
They are keyed by hostname.
For easier installation, the install scripts are available via shortlinks. To
(re)install a new machine from a Arch live environment:
```
curl --proto '=https' -sSfL https://s.hkoerber.de/i/${hostname}.sh | bash
```
## Manual Installation
Because it manages multiple users on the system, the directory is supposed to be
at `/var/lib/dotfiles`.
To setup the dotfiles:
To set up the dotfiles:
1. `git clone https://github.com/hakoerber/dotfiles.git ~/dotfiles`
2. `cd ~/dotfiles && ./install.sh`
# Partial application
## Partial application
To apply only a subset of the changes, use ansible tags that are available via
the Makefile:
| Command | Description |
| --- | --- |
| `make update` | Updates the system with the latest packages |
| Command | Description |
| --------------- | -------------------------------------------------- |
| `make packages` | Installs all defined packages (see `packages.yml`) |
| `make dotfiles` | Manages the users' dotfiles |
| `make dotfiles` | Manages the users' dotfiles |
Note that these are not supported on a first bootstrap run. Only use them after
the bootstrap to update existing configuration.