diff --git a/README.md b/README.md index 12fd670..e474ac9 100644 --- a/README.md +++ b/README.md @@ -19,6 +19,10 @@ encrypting and uploading them back to the server. ## Getting Started +The commands below need git, node 22 or later, and yarn. `make install`, which +builds the single binary that "Running the backup from cron" uses, also needs +[nix](https://nixos.org/download). + ```bash git clone https://git.eeqj.de/sneak/quak.git cd quak @@ -86,9 +90,12 @@ enumeration/download calls) is exported too and documented under Design below. ## Running the backup from cron `quak backup` never prompts, so cron can run it. `make install` builds quak as a -single binary and copies it to `~/bin/quak`. Log in once with it, as the user -the cron job will run as; the session is saved in that user's data directory -(see "Session handling"): +single binary and copies it to `~/bin/quak`. Besides what Getting Started needs, +it needs [nix](https://nixos.org/download), even where bun is already installed: +`make install` runs `make build-bin`, which bundles the built `dist/` with bun +run through `nix-shell -p bun`. Log in once with `~/bin/quak`, as the user the +cron job will run as; the session is saved in that user's data directory (see +"Session handling"): ```bash ~/bin/quak login diff --git a/TODO.md b/TODO.md index 1aa7f9b..f077269 100644 --- a/TODO.md +++ b/TODO.md @@ -17,7 +17,10 @@ pre-1.0 # Next Step -None: no implementation work is open. The check of quak against a live Ente +Four bugs are open: https://git.eeqj.de/sneak/quak/issues/196, +https://git.eeqj.de/sneak/quak/issues/197, +https://git.eeqj.de/sneak/quak/issues/198 and +https://git.eeqj.de/sneak/quak/issues/199. The check of quak against a live Ente account, https://git.eeqj.de/sneak/quak/issues/187, needs an account only sneak has, so it waits on him. @@ -26,6 +29,10 @@ declares one. # Completed Steps +- 2026-10-15: The README says that `make install` needs nix (issue 200), in + Getting Started and in "Running the backup from cron": `make build-bin` runs + bun through `nix-shell -p bun`. The `Makefile` is unchanged. + - 2026-10-14: `lib.backup()`, and so `quak backup`, works on up to the content pool's limit of originals at once, 5 by default, instead of one at a time (issue 182). That many workers take files from one shared list, each doing all