From 53eba915b3e943465050622e2dbd2e33e3599a93 Mon Sep 17 00:00:00 2001 From: Malin Freeborn Date: Mon, 27 Apr 2026 13:35:27 +0200 Subject: [PATCH] explain shell-like writing in readme --- README.md | 15 ++++++++++----- 1 file changed, 10 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index a950b62..29d762a 100644 --- a/README.md +++ b/README.md @@ -38,11 +38,6 @@ The output is a couple of lines of code, with changeable components as variables alias rrc='$PAGER "$(find . -maxdepth 2 -name "*rc" | fzf)"' ``` -### Guides - -The notes are mostly written like a heavily commented script. -Most are setup guides. - ### The Function Running `make function` outputs a shell function which searches through this @@ -133,6 +128,16 @@ grep ls --color=always $HISTFILE | $PAGER Now we can see what can be changed. +### Aim to Script + +Guides should read like a heavily commented script, so CLI commands are preferred to GUI commands. + +- Bad: '*edit the file `.config/tspreed/tspreed.rc` and change `focuscolor` to '2'.*' +- Good: `sed -i '/focuscolor/s/=1/=2/' ~/.config/tspreed/tspreed.rc` + * `cat !$` + +Despite being 'script-like', interactive bash commands like `cat !$` are still fine just to show how to double-check results when setting things up interactively. + ### Show, Don't Tell Articles should say what to type, not the output.