diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 26 |
1 files changed, 13 insertions, 13 deletions
@@ -1,27 +1,27 @@ # Dotfiles -Configuration files and scripts for my personal systems. +This repository contains my configuration for various pieces of software I use +(e.g. "dotfiles"). - +## Installation -## Structure +### Only Dotfiles The repository uses [GNU Stow](https://www.gnu.org/software/stow/) to manage symlinks between these configuration files and the user's home directory. -## Installation - -Clone the repository and run the installation script: +To install only the dotfiles: ```sh git clone git@github.com:eugenetriguba/dotfiles.git ~/.dotfiles -cd ~/.dotfiles -chmod u+x install.sh -./install.sh +cd .dotfiles +stow --target ~ . ``` -💡 Note: The repository is intended to be cloned into a top-level directory in -the `$HOME` directory because GNU Stow defaults to using the parent directory -for it's symlinking. If cloned elsewhere, the `stow` commands in `install.sh` -would need to be updated. +### System Setup + +I setup my whole system with an ansible playbook using my +[system-setup](git.sr.ht/~eugenetriguba/system-setup) repository. +This installs everything needed onto my system and _then_ symlinks these +configuration files into my home directory. |