lsd/README.md

# LSD

[![license](http://img.shields.io/badge/license-Apache%20v2-orange.svg)](https://raw.githubusercontent.com/Peltoche/ical-rs/master/LICENSE)
[![Latest version](https://img.shields.io/crates/v/lsd.svg)](https://crates.io/crates/lsd)

# Table of Contents

1. [Description](#description)
2. [Screenshot](#screenshot)
3. [Installation](#installation)
    1. [Archlinux](#archlinux)
    2. [Other](#other)
4. [Benchmark](#benchmark)
4. [Todo](#todo)

## Description

This project is heavily inspired by the super [colorls](https://github.com/athityakumar/colorls)
project but with some little differences. For example is written is rust and not ruby
which make it really faster ([see the benchmarks](#benchmark)).

## Screenshot

![image](https://raw.githubusercontent.com/Peltoche/lsd/assets/screen_lsd.png)

## Installation

### Archlinux

```
# With yaourt
yaourt lsd-git

# With yay
yay lsd-git
```

### Other

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.
3. Install the lsd package with `cargo install lsd`

## Benchmark

Result from `hyperfine --warmup 10 'lsd -la /etc/*' 'colorls -la /etc/*' --export-markdown out.md`:

| Command | Mean [ms] | Min…Max [ms] |
|:---|---:|---:|
| `lsd -la /etc/*` | 11.0 ± 0.5 | 9.9…13.0 |
| `colorls -la /etc/*` | 503.3 ± 5.6 | 494.6…513.4 |

## TODO

- [x] Handle the `-l` option (used by default for now)
- [x] Handle the `-a` option
- [x] Add icons before the files names
- [ ] Handle the tree (`--tree`) output option
- [ ] Handle the json (`--json`) output option
- [ ] Handle Named pipes
- [ ] Handle sockets
- [ ] Handle block devices
- [ ] Handle character devices
Add a basic README 2018-11-24 11:10:10 +00:00			`# LSD`

Add some badges 2018-11-25 16:42:23 +00:00			`[![license](http://img.shields.io/badge/license-Apache%20v2-orange.svg)](https://raw.githubusercontent.com/Peltoche/ical-rs/master/LICENSE)`
			`[![Latest version](https://img.shields.io/crates/v/lsd.svg)](https://crates.io/crates/lsd)`

Add a table of content 2018-11-25 16:37:12 +00:00			`# Table of Contents`

Fix typo 2018-11-25 16:39:41 +00:00			`1. [Description](#description)`
Add a table of content 2018-11-25 16:37:12 +00:00			`2. [Screenshot](#screenshot)`
			`3. [Installation](#installation)`
Improve the table of content 2018-11-25 16:39:17 +00:00			`1. [Archlinux](#archlinux)`
			`2. [Other](#other)`
Add a table of content 2018-11-25 16:37:12 +00:00			`4. [Benchmark](#benchmark)`
			`4. [Todo](#todo)`
Add a basic README 2018-11-24 11:10:10 +00:00
			`## Description`

Update the description 2018-11-24 16:57:04 +00:00			`This project is heavily inspired by the super [colorls](https://github.com/athityakumar/colorls)`
Improve the description 2018-11-24 16:58:54 +00:00			`project but with some little differences. For example is written is rust and not ruby`
Add a table of content 2018-11-25 16:37:12 +00:00			`which make it really faster ([see the benchmarks](#benchmark)).`
Add a todo list inside the README 2018-11-24 11:21:32 +00:00
Add a screenshot to the README 2018-11-24 11:31:28 +00:00			`## Screenshot`

			`![image](https://raw.githubusercontent.com/Peltoche/lsd/assets/screen_lsd.png)`

Add the Installation section inside the README 2018-11-25 11:23:22 +00:00			`## Installation`

Improve the table of content 2018-11-25 16:39:17 +00:00			`### Archlinux`
Add the AUR package to the installations 2018-11-25 13:10:56 +00:00
			```
			`# With yaourt`
			`yaourt lsd-git`

			`# With yay`
			`yay lsd-git`
			```

			`### Other`

Add the Installation section inside the README 2018-11-25 11:23:22 +00:00			`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.`
			3. Install the lsd package with `cargo install lsd`

Add some benchmark 2018-11-25 16:31:46 +00:00			`## Benchmark`

			Result from `hyperfine --warmup 10 'lsd -la /etc/' 'colorls -la /etc/' --export-markdown out.md`:

			`\| Command \| Mean [ms] \| Min…Max [ms] \|`
			`\|:---\|---:\|---:\|`
			\| `lsd -la /etc/*` \| 11.0 ± 0.5 \| 9.9…13.0 \|
			\| `colorls -la /etc/*` \| 503.3 ± 5.6 \| 494.6…513.4 \|

Add a todo list inside the README 2018-11-24 11:21:32 +00:00			`## TODO`

			- [x] Handle the `-l` option (used by default for now)
			- [x] Handle the `-a` option
Add the icons next to the file names 2018-11-24 12:05:44 +00:00			`- [x] Add icons before the files names`
Add a todo list inside the README 2018-11-24 11:21:32 +00:00			- [ ] Handle the tree (`--tree`) output option
			- [ ] Handle the json (`--json`) output option
Fix typo 2018-11-24 12:12:49 +00:00			`- [ ] Handle Named pipes`
Add a todo list inside the README 2018-11-24 11:21:32 +00:00			`- [ ] Handle sockets`
			`- [ ] Handle block devices`
			`- [ ] Handle character devices`