andonome/lk
2
1
Fork 1
Code Issues Pull Requests Packages Projects Releases Wiki Activity

explain shell-like writing in readme

Browse Source
This commit is contained in:
Malin Freeborn
2026-04-27 13:35:27 +02:00
parent 6a33521f33
commit 53eba915b3
1 changed files with 10 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
README.md
View File

@@ -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)"' 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 ### The Function
Running `make function` outputs a shell function which searches through this 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. 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 ### Show, Don't Tell
Articles should say what to type, not the output. Articles should say what to type, not the output.