diff --git a/README.md b/README.md index 308deb6..d293871 100644 --- a/README.md +++ b/README.md @@ -11,17 +11,40 @@ See --help for more info # Featured ## rawrsync -Easily sync or deploy projects over rsync. Intended to somewhat replicate CLion's Deployment feature for use with other IDEs. +Easily sync or deploy projects using `rsync`. Intended to somewhat replicate CLion's Deployment feature for use with other IDEs. + +Configure with `.rawrsync.toml` in your project root. For example: +```toml +[org-server-23] +user = "username" +address = "org-server-23.tailnet-name.ts.net" +path = "/home/username/deployment/project/" # Destination path on the server + +[vr-desktop] +user = "username" +address = "vr-desktop.tailnet-name.ts.net" +path = "/home/username/vr/project" +``` ## atproto-app-passwords Create an app password for your ATProto account. +TODO: Add subcommands to list and delete + ## update-gitignore Quickly and easily create or update `gitignore` files from predefined templates. ## adb-auto-connect Automatically find and connect to an Android device with Wireless Debugging over the local network. +You'll need to create a file at `~/.config/adb-auto-connect.nuon` with the MAC Addresses you want to search for. For example: +```json +[ + "ff:ff:ff:ff:ff:ff", + "aa:aa:aa:aa:aa:aa" +] +``` + ## auto-benchmark Set up and run a Blender benchmark on the specified device, then automatically compare your results to the results on [Blender Open Data](https://opendata.blender.org/). @@ -44,6 +67,11 @@ Remove broken symlinks from `~/.local/bin` ## detect-gpu-issues Detect issues with the GPU. +This was created for my own use on a Framework Laptop 16 with an external dock. +Sometimes, the external GPU will have issues caused by my hacky m.2 to oculink adapter. + +I can't guarantee this will work for you, but it does reliably detect when there is an issue on my system. + ## extract-m4a Extract audio from a m4a file to the codec's native container @@ -60,6 +88,10 @@ Reset all Watchman (lighthouse_console) dongles and put them into pairing mode. > [!NOTE] > I reccomend using a [lrclib](https://lrclib.net/) client such as [lrcget](https://github.com/tranxuanthang/lrcget) or [Chronograph](https://flathub.org/apps/io.github.dzheremi2.lrcmake-gtk) instead! +Fetches lyrics from Genius using a [Dumb](https://github.com/rramiachraf/dumb) instance, and adds them to your music library's metadata. + +Currently only supports FLAC files. + ## pods-remote Create a podman socket connection over SSH This will not work with Tailscale SSH, see https://github.com/tailscale/tailscale/issues/5295 @@ -78,6 +110,11 @@ to be started. ## steam-disable-update Completely disable steam updates for a game or app. +Caveats to this approach: +- Your "last played" time will never update +- I haven't used it in a long time, so I can't guarantee it will work +- It might cause other bugs, I haven't tested it extensively + ## toggle-extension Provides an easy way to toggle a GNOME extension. Useful for setting up keyboard shortcuts. diff --git a/meta/generate-readme.nu b/meta/generate-readme.nu index 0fa56be..a8c6c19 100755 --- a/meta/generate-readme.nu +++ b/meta/generate-readme.nu @@ -75,7 +75,13 @@ def generate-section [scripts: table] { return null } - return $"\n## ($e.name)\n($e.description)\n" + mut h2 = $"\n## ($e.name)\n" + $h2 ++= $e.description ++ "\n" + if ($e.extra_description? | is-not-empty) { + $h2 ++= "\n" ++ $e.extra_description? ++ "\n" + } + + return $h2 } | str join }