Skip to content

Commit 874a6b3

Browse files
committed
README cleanup
1 parent 281ba91 commit 874a6b3

File tree

1 file changed

+24
-9
lines changed

1 file changed

+24
-9
lines changed

README.md

Lines changed: 24 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,40 @@
11
# dotfiles
22

3-
My dotfiles, managed with stow.
3+
[![Lint](https://github.com/chadsr/dotfiles/actions/workflows/lint.yml/badge.svg)](https://github.com/chadsr/dotfiles/actions/workflows/lint.yml)
4+
5+
My dotfiles, managed with [`stow`](https://www.gnu.org/software/stow/).
46

57
## Setup
68

7-
```
8-
git clone git@github.com:Chadsr/dotfiles.git
9-
cd dotfiles
9+
```shell
10+
git clone git@github.com:chadsr/dotfiles.git && cd dotfiles/
1011
```
1112

1213
## Usage
1314

14-
Setup stow configs and also system configurations for the given system name:
15+
### Per-Directory
1516

17+
```bash
18+
stow -t ~/ stow
19+
stow <FOLDER_NAME>
1620
```
21+
22+
### Scripts
23+
24+
**Important:** *Don't run these scripts without modifications if your're not me, or haven't (yet) stolen my private keys.*
25+
26+
#### Automated Setup
27+
28+
`setup_all.sh` symlinks all stow directories to `$HOME`, sets up `gnupg` and installs system settings and other configurations. The script is designed to have a completely fresh Arch Linux system configured with minimal interaction.
29+
30+
```bash
1731
./setup_all.sh
1832
```
1933

20-
...or manually for local configs only:
34+
#### Backup
2135

22-
```
23-
stow -t ~/ stow
24-
stow <FOLDER_NAME>
36+
`store_secrets.sh` encrypts various configs and stores them as ASCII-Armoured `gpg` file outputs. `setup_all.sh` handles the decryption and checks (such as interactive diffs) for these files.
37+
38+
```bash
39+
./store_secrets.sh
2540
```

0 commit comments

Comments
 (0)