Updates README

This commit is contained in:
Athitya 2017-07-01 15:41:41 +05:30
parent faabe85060
commit 65e5971d75
5 changed files with 15 additions and 7 deletions

View file

@ -9,7 +9,7 @@ working example on an iTerm2 terminal (Mac OS), `oh-my-zsh` with `powerlevel9k`
# Making this work on your terminal
1. Install Ruby (prefably, version > 2.1)
2. Install the patched fonts of powerline nerd-font.
2. Install the patched fonts of powerline nerd-font and/or font-awesome.
3. Clone this repository with `git clone https://github.com/athityakumar/colorls.git`
4. Navigate to this cloned directory : `cd colorls`
5. Install bundler and dependencies :
@ -17,9 +17,9 @@ working example on an iTerm2 terminal (Mac OS), `oh-my-zsh` with `powerlevel9k`
gem install bundler
bundle install
```
6. Add an cli command (say, `colorls` to your shell configuration file (`~/.bashrc` or `~/.zshrc`) :
```
function colorls()
6. For CLI functionality, add a function (say, `lc`) to your shell configuration file (`~/.bashrc` or `~/.zshrc`) :
```sh
function lc()
{
ruby /path/to/colorls/colorls.rb $1;
}
@ -27,9 +27,17 @@ working example on an iTerm2 terminal (Mac OS), `oh-my-zsh` with `powerlevel9k`
_Note : I have aliased it to `lc`, as it can be seen from the screenshot._
# Contributing to the repository
7. Change the `aliases.yaml` and `formats.yaml` files, if required. (Say, add custom icons)
8. Open a new terminal, and start using `lc` :tada:
Please feel free to contribute to this project, by either
# Contributing to this project
There are a couple of formats that aren't recognized yet.
![Pending formats](readme/pending.png)
Please feel free to contribute to this project, by
- opening an issue for reporting any bug / suggesting any enhancement
- cleaning up the `colorls.rb` ruby script with more functionalities.
- adding support for more file [formats](formats.yaml) and/or [aliases](aliases.yaml).

View file

@ -8,7 +8,7 @@ class ColorLS
def initialize(input, report)
@input = input || Dir.pwd
@contents = Dir.entries(@input) - ['.', '..']
@count = {folders: 0, recognized_files: 0, unrecognized_files: 0}
@count = { folders: 0, recognized_files: 0, unrecognized_files: 0 }
@report = report
@screen_width = TermInfo.screen_size.last
@max_widths = @contents.map(&:length)

Binary file not shown.

Before

Width:  |  Height:  |  Size: 56 KiB

After

Width:  |  Height:  |  Size: 182 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 77 KiB

After

Width:  |  Height:  |  Size: 117 KiB

BIN
readme/pending.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 90 KiB