diff --git a/.forgejo/workflows/shellcheck.yml b/.forgejo/workflows/shellcheck.yml deleted file mode 100644 index 60c7de6..0000000 --- a/.forgejo/workflows/shellcheck.yml +++ /dev/null @@ -1,11 +0,0 @@ -name: ShellCheck - -on: [push, pull_request] - -jobs: - shellcheck: - runs-on: ubuntu-latest - steps: - - uses: actions/checkout@v4 - - name: Run ShellCheck - run: shellcheck dotgit.sh demo/demo-note.sh diff --git a/README.md b/README.md index b0dac9b..23839fc 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,6 @@ -# dotGit ::: 🪄 dotfiles + 🧸 bare git repo + 🐚 shell aliases -### a minimal and effective approach to dotfiles (and git repos) - # dotGit ::: 🪄 dotfiles + 🧸 bare git repo + 🐚 shell aliases ::: a minimal and effective approach to dotfiles (and git repos) -[![ShellCheck](https://code.opennomad.com/opennomad/dotGit/actions/workflows/shellcheck.yml/badge.svg)](https://code.opennomad.com/opennomad/dotGit/actions?workflow=shellcheck.yml) - -Dotfiles are scattered across `$HOME`. Can't remember where you set the `PATH`, or where you defined that alias three months ago? `.gg PATH` greps across every tracked dotfile and drops you straight to the line. `.ge` fuzzy-finds any file by name with a live preview. Under the hood it's a [bare git repo](https://news.ycombinator.com/item?id=11070797), so files stay exactly where tools expect them and everything else is standard git behind some aliases. - -Bonus: set `DOTGIT_ANYGIT=yes` and the same gg/ge aliases (without the leading dot) work across all your repos. +Your dotfiles are scattered across `$HOME`. You can't remember which file sets `PATH`, or where you defined that alias three months ago. `.gg PATH` greps across every tracked dotfile and drops you straight to the line. `.ge` fuzzy-finds any file by name with a live preview. Under the hood it's a [bare git repo](https://news.ycombinator.com/item?id=11070797), so files stay exactly where tools expect them and everything else is standard git. ![dotGit demo](demo/demo.gif) @@ -148,7 +141,7 @@ Everything else is a standard git alias pointed at the dotfiles repo. ### ANYGIT -Setting `DOTGIT_ANYGIT=yes` causes dotGit to source a transformed copy of itself that registers a parallel set of aliases without the leading `.` — so `.ga` becomes `ga`, `.gc` becomes `gc`, etc. These work against whichever git repo your shell is currently in, like ordinary git aliases. Yes, `ge` and `gg` are included. +Setting `DOTGIT_ANYGIT=yes` causes dotGit to source a transformed copy of itself that registers a parallel set of aliases without the leading `.` — so `.ga` becomes `ga`, `.gc` becomes `gc`, etc. These work against whichever git repo your shell is currently in, like ordinary git aliases. ## initial clone cleanup