Skip to content

Commit

Permalink
Update README usage & install notes.
Browse files Browse the repository at this point in the history
  • Loading branch information
drn committed Nov 11, 2018
1 parent afa0f28 commit 749f1d9
Showing 1 changed file with 27 additions and 7 deletions.
34 changes: 27 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,19 +8,39 @@ A golang LS implementation that provides color and icons to `ls`.

<p align="center"><img src="screenshot.png" width="600"></p>

## Install
## Usage

Nerd LS is a drop-in replacement for the standard ls command.

```
Usage:
nerd-ls [OPTIONS]
Requires a
[nerd-font patched font](https://github.com/ryanoasis/nerd-fonts#patched-fonts)
for the custom icons. My preferred font is a patched Menlo font that you can
find
[here](https://github.com/drn/dots/blob/master/lib/fonts/Menlo%20Regular%20Nerd%20Font%20Complete.otf).
Application Options:
-a, --all Include directory entries whose names begin with a dot (.)
-l, --long List in long format
-i, --icon Display nerd-font icons
Help Options:
-h, --help Show this help message
```

## Install

```
go get github.com/drn/nerd-ls
alias ls=nerd-ls
alias ls=nerd-ls # optional
```

In order to have icons included with the -i/--icon flag, a patched
[Nerd Font](http://nerdfonts.com/)
is required.

Font Options:

* [Patched Font Directory](https://github.com/ryanoasis/nerd-fonts#patched-fonts)
* [Menlo Regular Nerd Font Complete](https://github.com/drn/dots/blob/master/lib/fonts/Menlo%20Regular%20Nerd%20Font%20Complete.otf)

## Benchmarks

ls
Expand Down

0 comments on commit 749f1d9

Please sign in to comment.