lsd/README.md

33 lines
1.1 KiB
Markdown
Raw Normal View History

2018-11-24 11:10:10 +00:00
# LSD
A ls command with a lot of pretty colors.
## Description
2018-11-24 16:57:04 +00:00
This project is heavily inspired by the super [colorls](https://github.com/athityakumar/colorls)
2018-11-24 16:58:54 +00:00
project but with some little differences. For example is written is rust and not ruby
which make it really faster (around 10 times).
2018-11-24 11:21:32 +00:00
2018-11-24 11:31:28 +00:00
## Screenshot
![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`
2018-11-24 11:21:32 +00:00
## TODO
- [x] Handle the `-l` option (used by default for now)
- [x] Handle the `-a` option
2018-11-24 12:05:44 +00:00
- [x] Add icons before the files names
2018-11-24 11:21:32 +00:00
- [ ] Handle the tree (`--tree`) output option
- [ ] Handle the json (`--json`) output option
2018-11-24 12:12:49 +00:00
- [ ] Handle Named pipes
2018-11-24 11:21:32 +00:00
- [ ] Handle sockets
- [ ] Handle block devices
- [ ] Handle character devices