From fd929b39a9be9a28e40301e7fe130e30f141572c Mon Sep 17 00:00:00 2001 From: Peltoche Date: Tue, 4 Dec 2018 15:07:15 +0100 Subject: [PATCH] Add the recommended configurations into the README --- README.md | 31 +++++++++++++++++++++++++++++-- 1 file changed, 29 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 6b7bf43..ebe6de1 100644 --- a/README.md +++ b/README.md @@ -11,8 +11,11 @@ 3. [Installation](#installation) 1. [Archlinux](#archlinux) 2. [Other](#other) -4. [Benchmark](#benchmark) -4. [Todo](#todo) +4. [Recommended configurations](#recommended configurations) + 1. [Required](#required) + 2. [Optional](#optional) +5. [Benchmark](#benchmark) +6. [Todo](#todo) ## Description @@ -36,6 +39,30 @@ which make it really faster ([see the benchmarks](#benchmark)). 2. Install the patched fonts of powerline nerd-font and/or font-awesome. Have a look at the [Nerd Font README](https://github.com/ryanoasis/nerd-fonts/blob/master/readme.md) for more installation instructions. 3. Install the lsd package with `cargo install lsd` +## Recommended Configurations + +### Required + +In order to use lsd instead of the default ls you need to add this to you shell +configuration file (~/.bashrc, ~/.zshrc, etc.) : + + ``` + alias ls='lsd' + ``` + +### Optional + +Some examples of useful aliases. You can add this to you shell configuration +file (~/.bashrc, ~/.zshrc, etc.) just under the alias above : + + ``` + alias l='ls -l' + alias la='lsd -a' + alias lla='ls -la' + alias lt='ls --tree' + ``` + + ## Benchmark Result from `hyperfine --warmup 10 'lsd -la /etc/*' 'colorls -la /etc/*' --export-markdown out.md`: