Skip to content

Commit

Permalink
docs: update readme to use LSR_COLORS
Browse files Browse the repository at this point in the history
Signed-off-by: jmattaa <mattajonathan1@gmail.com>
  • Loading branch information
jmattaa committed Nov 5, 2024
1 parent 0d7d966 commit 63cc66b
Showing 1 changed file with 20 additions and 5 deletions.
25 changes: 20 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down

0 comments on commit 63cc66b

Please sign in to comment.