From 63cc66be0f7f1c566b3f753dbfe65ea352951646 Mon Sep 17 00:00:00 2001 From: jmattaa Date: Tue, 5 Nov 2024 21:48:12 +0100 Subject: [PATCH] docs: update readme to use LSR_COLORS Signed-off-by: jmattaa --- README.md | 25 ++++++++++++++++++++----- 1 file changed, 20 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index a75202f..6e20c32 100644 --- a/README.md +++ b/README.md @@ -17,11 +17,6 @@ It can even display the directory contents in a tree-like structure! :fire: ### Building from source -> [!NOTE] -> If you want to disable the nerdfonts symbols remove the -`-DLASER_NF_SYMBOLS` flag from the `Makefile` under the variable `LASER_DEFINES` -before compiling. - Clone the repository: ```sh @@ -51,6 +46,26 @@ lsr lsr some-directory ``` +### Change colors or add icons + +If you want to change the colors of the output you can set an environment +variable called `LSR_COLORS` for example if you want to add nerd font icons to +the existing colors you can use: + +```sh +export LSR_COLORS="RESET=\x1b[0m:\ +DIR=\x1b[34m :\ +SYMLINK=\x1b[36m :\ +FILE=\x1b[38m :\ +HIDDEN=\x1b[90m :\ +EXEC=\x1b[32m :\ +ARCHIVE=\x1b[31m :\ +MEDIA=\x1b[33m" +``` + +You don't have to change all of these if there is only one you want to change +you can do that, to leave the rest on default + ### Command-line options The command-line options can be added by passing flags. These flags can be put