aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorDanilo M. <danix@danix.xyz>2026-05-06 09:42:55 +0200
committerDanilo M. <danix@danix.xyz>2026-05-06 09:42:55 +0200
commit78742f69a5080fe0bdab7dac61400028ee107a37 (patch)
tree40e544b0cf37c25c323b49a6eecec585d977b2ea /README.md
parent1076091203f9387385e663ad19c7ea3648650bec (diff)
downloaddots-backup-78742f69a5080fe0bdab7dac61400028ee107a37.tar.gz
dots-backup-78742f69a5080fe0bdab7dac61400028ee107a37.zip
Bootstrap config dirs on first run with setup message
Script now creates ~/.config/dot-backup/ and ~/.local/share/dot-backup/ on first run and prints a summary with next steps. README updated. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Diffstat (limited to 'README.md')
-rw-r--r--README.md16
1 files changed, 14 insertions, 2 deletions
diff --git a/README.md b/README.md
index 1550e51..fa59028 100644
--- a/README.md
+++ b/README.md
@@ -34,7 +34,20 @@ cd dots-backup
./dot-backup.sh
```
-On first run the script creates `~/Programming/GIT/my-dotfiles` and initializes a git repo inside it. Add a remote so you can push:
+On first run the script:
+
+1. Creates `~/.config/dot-backup/` and `~/.local/share/dot-backup/` and prints a short setup summary
+2. Creates `~/Programming/GIT/my-dotfiles/{home,system}` and initializes a git repo inside it
+3. Runs the backup immediately using built-in defaults
+
+Optionally set up a config file and custom files list (script will tell you the exact paths):
+
+```bash
+cp config.example ~/.config/dot-backup/config
+touch ~/.config/dot-backup/files.list
+```
+
+Add a remote to the backup repo so you can push:
```bash
cd ~/Programming/GIT/my-dotfiles
@@ -96,7 +109,6 @@ System files (absolute paths like `/etc/bash_completion.d`) may need `sudo`.
Copy `config.example` to `~/.config/dot-backup/config` and edit:
```bash
-mkdir -p ~/.config/dot-backup
cp config.example ~/.config/dot-backup/config
```