From c9b8ae723d0aaa40bf2558d07d2c0b2acb90e9e8 Mon Sep 17 00:00:00 2001 From: Athitya Kumar Date: Mon, 30 Oct 2017 04:22:14 +0530 Subject: [PATCH] Update README.md --- README.md | 82 +++++++++++++++++++++++++++++++++++++++++++------------ 1 file changed, 65 insertions(+), 17 deletions(-) diff --git a/README.md b/README.md index cc9383f..660c012 100644 --- a/README.md +++ b/README.md @@ -9,13 +9,27 @@ A Ruby script that colorizes the `ls` output with color and icons. Here are the screenshots of working example on an iTerm2 terminal (Mac OS), `oh-my-zsh` with `powerlevel9k` theme and `powerline nerd-font + awesome-config` font with the `Solarized Dark` color theme. -![Example #1](readme/usage1.png) + ![image](https://user-images.githubusercontent.com/17109060/32149040-04f3125c-bd25-11e7-8003-66fd29bc18d4.png) *If you're interested in knowing the powerlevel9k configuration to get this prompt, have a look at [this gist](https://gist.github.com/athityakumar/1bd5e9e24cd2a1891565573a893993eb).* # Table of contents - [Usage](#usage) + - [Flags](#flags) + - `-1` + - `-a` (or) `--all` + - `-A` (or) `--almost-all` + - `-d` (or) `--dirs` + - `-f` (or) `--files` + - `-h` (or) `--help` + - `-l` (or) `--long` + - `-r` (or) `--report` + - `-t` (or) `--tree` + - `--gs` (or) `--git-status` + - `--sd` (or) `--sort-dirs` or `--group-directories-first` + - `--sf` (or) `--sort-files` + - [Combination of flags](#combination-of-flags) - [Installation](#installation) - [Recommended configurations](#recommended-configurations) - [Custom configurations](#custom-configurations) @@ -28,34 +42,68 @@ A Ruby script that colorizes the `ls` output with color and icons. Here are the [(Back to top)](#table-of-contents) -- With `-a` : `lc` prints all directories, files and dotfiles in current directory. +### Flags +- With `-1` : Lists one entry per line - ![Usage #1](readme/usage1.png) + ![image](https://user-images.githubusercontent.com/17109060/32149062-4f0547ca-bd25-11e7-98b6-587467379704.png) -- With paths : `lc path(s) -a` prints all directories, files and dotfiles in given directory / directories. +- With `-a` (or) `--all` : Does not ignore entries starting with '.' - ![Usage #2](readme/usage2.png) + ![image](https://user-images.githubusercontent.com/17109060/32149045-182eb39e-bd25-11e7-83d4-897cb14bcff3.png) -- With `--report` or `-r` flag : `lc path(s) -r -a` : Prints all directories, files and dotfiles in directories, along with a brief report about number of files and folders shown. +- With `-A` (or) `--almost-all` : Does not ignore entries starting with '.', except `./` and `../` - ![Usage #3](readme/usage3.png) - ![Usage #4](readme/usage4.png) + ![image](https://user-images.githubusercontent.com/17109060/32149046-1ef7664e-bd25-11e7-8bd9-bfc3c8b27b74.png) -- With `--sort-dirs` / `-sd` or `--sort-files` / `-sf` : Entries are sorted directories-first or files-first, and then alphabetically (case-insensitively) before being printed. +- With `-d` (or) `--dirs` : Shows only directories - ![Usage #5](readme/usage5.png) - ![Usage #6](readme/usage6.png) + ![image](https://user-images.githubusercontent.com/17109060/32149066-5f842aa8-bd25-11e7-9bf0-23313b717182.png) -- With `--dirs` / `-d` or `--files` / `-f` : Entries are filtered so that only directories or files are shown. +- With `-f` (or) `--files` : Shows only files - ![Usage #7](readme/usage7.png) - ![Usage #8](readme/usage8.png) + ![image](https://user-images.githubusercontent.com/17109060/32149065-5a27c9d4-bd25-11e7-9a2b-fd731d76a058.png) -- With `-1` : Entries are printed in a column (one per line), just like `ls -1` does. +- With `-h` (or) `--help` : Prints a very helpful help menu - ![Usage #9](readme/usage9.png) + ![image](https://user-images.githubusercontent.com/17109060/32149096-cf2cf5b0-bd25-11e7-84b6-909d79099c98.png) -- Additional flags: `--almost-all` or `-A`, `--long` or `-l`, `--tree` or `-t` +- With `-l` (or) `--long` : Shows in long listing format + + ![image](https://user-images.githubusercontent.com/17109060/32149049-2a63ae48-bd25-11e7-943c-5ceed25bd693.png) + +- With `-r` (or) `--report` : Shows brief report about number of files and folders shown + + ![image](https://user-images.githubusercontent.com/17109060/32149082-96a83fec-bd25-11e7-9081-7f77e4c90e90.png) + +- With `-t` (or) `--tree` : Shows tree view of the directory + + ![image](https://user-images.githubusercontent.com/17109060/32149051-32e596e4-bd25-11e7-93a9-5e50c8d2bb19.png) + +- With `--gs` (or) `--git-status` : Shows git status for each entry + + ![image](https://user-images.githubusercontent.com/17109060/32149075-7a1a1954-bd25-11e7-964e-1adb173aa2b9.png) + +- With `--sd` (or) `--sort-dirs` or `--group-directories-first` : Shows directories first, followed by files + + ![image](https://user-images.githubusercontent.com/17109060/32149068-65117fc0-bd25-11e7-8ada-0b055603e3fd.png) + +- With `--sf` (or) `--sort-files` : Shows files first, followed by directories + + ![image](https://user-images.githubusercontent.com/17109060/32149071-6b379de4-bd25-11e7-8764-a0c577e526a1.png) + +### Combination of flags + +- Using `--gs` with `-t` : + + ![image](https://user-images.githubusercontent.com/17109060/32149076-8423c864-bd25-11e7-816e-8642643d2c27.png) + +- Using `--gs` with `-l` : + + ![image](https://user-images.githubusercontent.com/17109060/32149078-899b0622-bd25-11e7-9810-d398eaa77e32.png) + +- Using `--sd` with `-l` and `-A` : + + ![image](https://user-images.githubusercontent.com/17109060/32149084-9eb2a416-bd25-11e7-8fb7-a9d336c6e038.png) # Installation