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

Adds usage and tweaking section to README

Browse source
This commit is contained in:
Athitya 2017-07-01 15:54:11 +05:30
parent 1fbd3a723b
commit 405b3f03b2
1 changed files with 11 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

15
README.md
View file

@ -5,7 +5,7 @@ working example on an iTerm2 terminal (Mac OS), `oh-my-zsh` with `powerlevel9k`
![Example #1](readme/example1.png)
![Example #2](readme/example2.png)
# Making this work on your terminal
# Installation steps
1. Install Ruby (prefably, version > 2.1)
2. Install the patched fonts of powerline nerd-font and/or font-awesome.
@ -27,14 +27,21 @@ 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._
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:
8. Open a new terminal, and start using `lc` :tada:
# Contributing to this project
# How to use
There are a couple of formats that aren't recognized yet.
- `lc` : Prints all directories, files and dotfiles in current directory.
- `lc path` : Prints all directories, files and dotfiles in `path` directory.
- `lc path1 path2` : Prints all directories, files and dotfiles in directories `path1` and `path2`.
- `lc path1 path2 --report` : Prints above details, along with metdata such as number of folders, recognized file formats & unrecognized file formats.
# Tweaking this project
![Pending formats](readme/pending.png)
There are a couple of formats that aren't recognized yet. Custom file formats and icons can be added by changing the files : [formats](formats.yaml) and/or [aliases](aliases.yaml). If it looks good, feel free to send a Pull Request here.
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.