diff --git a/README.md b/README.md index e99cb10..b6337a5 100644 --- a/README.md +++ b/README.md @@ -147,6 +147,56 @@ See `other/example/example-home.nix` for a working example. --- +### 4. Rebuild and you can use it: + +```bash +# to just do a simple rebuild you can: +nyx-rebuild + +# to see the available options: +$ nyx-rebuild -h +nyx-rebuild [--repair] [--update] + + --repair Stage & commit the nix_dir with "rebuild - repair " + and remove any unfinished logs (Current-Error*.txt and rebuild-*.log + that are not final nixos-gen_* logs). + + --update Before rebuilding, update the flake in nix_dir using: + nix flake update + +# to cleanup old configurations: +nyx-cleanup + +# And to see the other options: +nyx-cleanup -h +nyx-cleanup [--dry-run] [--keep N] + +Prunes old *system* generations, runs GC (and store optimise), and tidies logs. + +Options: + --dry-run Show actions without doing them. + --keep N Override configured generations to keep (default: 5). + -h, --help Show this help. + + +# For nyx-tui run simply +nyx-tui + +# or for a small startup animation +nyx-tui --pretty + + +``` + +##### Showcase +
+nyx-tui +[Video](other/Ressources/showcase.mp4) + +
+ +--- + ## Module Options ### `nyx.nyx-rebuild` diff --git a/other/Ressources/showcase.mp4 b/other/Ressources/showcase.mp4 new file mode 100644 index 0000000..ce651e5 Binary files /dev/null and b/other/Ressources/showcase.mp4 differ