linux/colorls
0
0
Fork 0
mirror of https://github.com/athityakumar/colorls.git synced 2024-09-12 05:31:14 +02:00
Code Issues Projects Releases Wiki Activity

Updates README with Ruby gem installation steps

Browse source
This commit is contained in:
Athitya 2017-07-06 21:28:32 +05:30
parent 3bfa362121
commit 3d7522c14d
1 changed files with 19 additions and 33 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

52
README.md
View file

@ -1,18 +1,11 @@
# Color LS
[![Gem Version](https://badge.fury.io/rb/colorls.svg)](https://badge.fury.io/rb/colorls)
[![Build Status](https://travis-ci.org/athityakumar/colorls.svg?branch=master)](https://travis-ci.org/athityakumar/colorls)
[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=shields)](http://makeapullrequest.com)
[![Awesome](https://cdn.rawgit.com/sindresorhus/awesome/d7305f38d29fed78fa85652e3a63e154dd8e8829/media/badge.svg)](https://github.com/sindresorhus/awesome)
[![forthebadge](http://forthebadge.com/images/badges/made-with-ruby.svg)](http://forthebadge.com)
[![forthebadge](http://forthebadge.com/images/badges/built-with-love.svg)](http://forthebadge.com)
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.
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)
@ -49,36 +42,29 @@ terminal (Mac OS), `oh-my-zsh` with `powerlevel9k` theme and `powerline nerd-fon
1. Install Ruby (prefably, version > 2.1)
2. Install the patched fonts of powerline nerd-font and/or font-awesome.
3. Clone this repository to `~/bin` (create if not exist or clone elsewhere) with
```sh
cd ~/bin && git clone https://github.com/athityakumar/colorls.git
```
4. Navigate to this cloned directory : `cd colorls`
5. Install bundler and dependencies :
```
gem install bundler
bundle install
```
6. For CLI functionality, add a function (say, `lc`) to your shell configuration file (`~/.bashrc` or `~/.zshrc`) :
```sh
lc () { ruby ~/bin/colorls/colorls.rb $1; }
```
7. If you like the report flag you can make it default by adding:
3. Install the [colorls](https://rubygems.org/gems/colorls/) ruby gem with `gem install colorls`
4. Start using `lc` :tada:
# Tweaking the configurations
1. To add some flag options by default, add this to your shell configuration file (`~/.bashrc`, `~/.zshrc` or `~/.fishrc`) :
```sh
alias lc='lc -r'
```
8. Change the YAML files, if required. (Say, to add / change / remove some icons)
9. Open a new terminal, and start using `lc` :tada:
2. For changing the icon(s) to other unicode icons of choice (select icons from [here](https://nerdfonts.com/)), change the YAML files in a text editor of your choice (say, `subl`)
_NOTE: If you're iTerm2 on Mac, you may have to enable the nerd-font at iTerm2 > Preferences > Profiles > Text > Non-Ascii font > Knack Regular Nerd Font Complete_
```sh
subl $(gem which colorls)/../yaml/
```
# Uninstall Instructions
_NOTE: If you're using iTerm2 on Mac, you may have to enable the nerd-font at iTerm2 > Preferences > Profiles > Text > Non-Ascii font > Knack Regular Nerd Font Complete_
# Uninstallation steps
Want to uninstall and revert back to the old style?
```sh
rm -rf ~/bin/colorls
gem uninstall colorls
```
Run the above command and reset your terminal profile.
# Tweaking this project
@ -87,9 +73,9 @@ Run the above command and reset your terminal profile.
There are a couple of formats that aren't recognized yet. Custom file formats and icons can be added by changing the YAML files in this repository. Also, feel free to send a Pull Request here with the added icons. :smile:
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 icons by editing the YAML files.
- opening an issue for reporting any bug / suggesting any enhancement.
- cleaning up the ruby scripts of the gem.
- adding support for more icons by editing the [YAML files](lib/yaml/).
# LICENSE