aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
blob: d53cb86bdf72b344a350416a483b531d1d8aa1a6 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
# Dotfiles

Configuration files and scripts for my personal systems.

![Screenshot of Development Environment](./docs/screenshots/overview.webp)

## Structure

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:

```sh
git clone git@github.com:eugenetriguba/dotfiles.git ~/.dotfiles
cd ~/.dotfiles
chmod u+x install.sh
./install.sh
```

💡 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.