summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorPeltoche <dev@halium.fr>2018-11-25 12:23:22 +0100
committerPeltoche <dev@halium.fr>2018-11-25 12:23:22 +0100
commit7c9ef33e7ac93a6db1fd40210054f22e5530c84b (patch)
tree2c3d552584cf867879d72e915b2ab260d5b3ea56 /README.md
parent6ecd04e8c7c5268b17477b9831e897a34d2be969 (diff)
Add the Installation section inside the README
Diffstat (limited to 'README.md')
-rw-r--r--README.md7
1 files changed, 7 insertions, 0 deletions
diff --git a/README.md b/README.md
index 12e5f2f..1725c6e 100644
--- a/README.md
+++ b/README.md
@@ -12,6 +12,13 @@ which make it really faster (around 10 times).
![image](https://raw.githubusercontent.com/Peltoche/lsd/assets/screen_lsd.png)
+## Installation
+
+1. Install rust
+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.
+ *Note for `rbenv` users - In case of load error when using `lc`, please try the below patch.*
+3. Install the lsd package with `cargo install lsd`
+
## TODO
- [x] Handle the `-l` option (used by default for now)