From 4f7c3e0fbd34fe34326b1356778c432511cce392 Mon Sep 17 00:00:00 2001 From: Mark Joshwel Date: Mon, 20 Jan 2025 05:05:26 +0800 Subject: [PATCH] docs: oopses --- LICENCE | 2 +- README.md | 24 ++++++++++++++++-------- 2 files changed, 17 insertions(+), 9 deletions(-) diff --git a/LICENCE b/LICENCE index 1a3cd04..149d617 100644 --- a/LICENCE +++ b/LICENCE @@ -1,4 +1,4 @@ -BSD Zero Clause License +BSD Zero Clause License Copyright (c) 2025 mark joshwel diff --git a/README.md b/README.md index 30125c8..347e20f 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,22 @@ -# sota staircase SideStepper +# sota staircase SideStepper -a fast .gitignore-respecting large file finder for .git repositories trying to -weed out large LFS files +a fast enough .gitignore-respecting large file finder + +made for me to find large files in my unity game repositories that wouldn't +fit github's 100mb limit, for when i'd push my repositories to github for +schoolwork submission + +rewritten from [python](https://forge.joshwel.co/mark/sota/src/branch/main/sidestepper.py) +to rust, as a reason to learn rust **this is brain made software**: large language-based code generation has not -directly used here. but i'd be lying if i said i didn't ask chatgpt if there -was a better way to check a boolean result lol +been extensively used here. but i'd be lying if i said i didn't ask chatgpt if +there was a better way to check a boolean result lol ## quickstart +**note:** there aren't any releases nor a nix flake yet! + ### installing a binary **note:** all non-windows builds are statically linked @@ -24,9 +32,9 @@ was a better way to check a boolean result lol ### build it yourself 1. [get rust and cargo](https://doc.rust-lang.org/cargo/getting-started/installation.html#install-rust-and-cargo) -2. `cargo build release` +2. run `cargo build release` -**nix users, rejoice:** `nix run github:markjoshwel/sidestepper` or `nix run git+:https://forge.joshwel.co/mark/sidestepper` +**nix users, rejoice:** run `nix run github:markjoshwel/sidestepper` or `nix run git+:https://forge.joshwel.co/mark/sidestepper` ### running it @@ -44,7 +52,7 @@ it'll find for a `.git` directory in the current or parent directories, if you want to use this not in the context i usually use this for, pass in `--search-here` to treat the current working directory as the 'repository root' -it'll then make a `.sotaignore` file that i use in my other tooling, +it'll then make a `.sotaignore` file that i use in my other tooling scripts, but if you want output more friendly for integration in other places, pass in `--plumbing` for it to output encountered large files, line-by-line, to stdout