mark/sidestepper
1
0
Fork 0
Code Issues Pull requests Projects Releases 2 Packages Wiki Activity Actions

docs: oopses

Browse source
This commit is contained in:
Mark Joshwel 2025-01-20 05:05:26 +08:00
parent bd20e7d29a
commit 4f7c3e0fbd
2 changed files with 17 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
LICENCE
View file

@ -1,4 +1,4 @@
BSD Zero Clause License
BSD Zero Clause License
Copyright (c) 2025 mark joshwel <mark@joshwel.co>

24
README.md
View file

@ -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