From d25911c8e8aed1f4169efb097426b553511c0bd4 Mon Sep 17 00:00:00 2001 From: Kyosuke Fujimoto Date: Sun, 1 Sep 2024 17:15:10 +0900 Subject: [PATCH] Update README --- README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/README.md b/README.md index 14fa971..2362eec 100644 --- a/README.md +++ b/README.md @@ -93,6 +93,7 @@ Usage: serie [OPTIONS] Options: -p, --protocol Image protocol to render graph [default: auto] [possible values: auto, iterm, kitty] -o, --order Commit ordering algorithm [default: chrono] [possible values: chrono, topo] + --preload Preload all graph images --no-cache Do not use graph image cache -h, --help Print help -V, --version Print version @@ -101,6 +102,7 @@ Options: #### -p, --protocol \ A protocol type for rendering images of commit graphs. + By default `auto` will guess the best supported protocol for the current terminal. Kitty terminals are detected as `kitty` via an environment variable, and all others are assumed to support `iterm`. @@ -116,6 +118,12 @@ Refer to [Compatibility](#compatibility) for details. +#### --preload + +By default, graph images are generated and loaded lazily as needed. + +If `--preload` is specified, all graph images will be generated and loaded at startup. This can result in smoother scrolling, as the images are already available, and might reduce memory usage. However, this may lead to slower startup times, especially for large repositories. + #### --no-cache The generated graph image is saved in `$XDG_CACHE_HOME/serie` and reused.