mirror of
https://github.com/athityakumar/colorls.git
synced 2024-09-05 05:21:16 +02:00
Adds some more markdown files
This commit is contained in:
Athitya
parent
3d7522c14d
commit
d421ce9ce7
3 changed files with 68 additions and 21 deletions
45
CONTRIBUTING.md
Normal file
45
CONTRIBUTING.md
Normal file
|
|
@ -0,0 +1,45 @@
|
|||
# Contribution guidelines
|
||||
|
||||
First of all, thanks for thinking of contributing to this project. :smile:
|
||||
|
||||
Before sending a Pull Request, please make sure that you're assigned the task on a GitHub issue.
|
||||
|
||||
- If a relevant issue already exists, discuss on the issue and get it assigned to yourself on GitHub.
|
||||
- If no relevant issue exists, open a new issue and get it assigned to yourself on GitHub.
|
||||
|
||||
Please proceed with a Pull Request only after you're assigned. It'd be sad if your Pull Request (and your hardwork) isn't accepted just because it isn't idealogically compatible.
|
||||
|
||||
# Developing the gem
|
||||
|
||||
1. Install with
|
||||
|
||||
```sh
|
||||
git clone
|
||||
cd colorls
|
||||
gem install bundler
|
||||
bundle install
|
||||
```
|
||||
|
||||
2. Make your changes in a different git branch. These changes can be
|
||||
|
||||
- add better icons to [YAML files](lib/yaml/)
|
||||
- add more flag options to the ruby gem.
|
||||
|
||||
|
||||
3. (Optional) To test whether `lc` is working properly, do
|
||||
```sh
|
||||
rake install
|
||||
lc # start using lc
|
||||
```
|
||||
|
||||
4. (Required for YAML file changes) These are the specifications for the YAML files -
|
||||
|
||||
- `files.yaml`, `folders.yaml` : The keys are sorted alphabetically.
|
||||
- `file_aliases.yaml`, `folder_aliases.yaml` : The values are sorted alphabetically. For each set of keys mapping to a value, those set of keys are also sorted alphabetically.
|
||||
|
||||
5. Check before pushing
|
||||
|
||||
```sh
|
||||
bundle exec rubocop
|
||||
bundle exec rspec
|
||||
```
|
||||
|
|
@ -1,6 +1,6 @@
|
|||
The MIT License (MIT)
|
||||
|
||||
Copyright (c) 2017 Athitya
|
||||
Copyright (c) 2017 [Athitya Kumar](https://github.com/athityakumar/)
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
|
|
@ -18,4 +18,4 @@ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
||||
THE SOFTWARE.
|
||||
THE SOFTWARE.
|
||||
40
README.md
40
README.md
|
|
@ -7,9 +7,20 @@
|
|||
|
||||
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.
|
||||
|
||||
# Table of contents
|
||||
|
||||
- [Usage](#usage)
|
||||
- [Installatation](#installation)
|
||||
- [Optional configurations](#optional-configurations)
|
||||
- [Uninstallation](#uninstallation)
|
||||
- [Contribute to this gem](CONTRIBUTING.md)
|
||||
- [License](LICENSE.md)
|
||||
|
||||
|
||||
|
||||
# How to use
|
||||
# Usage
|
||||
|
||||
[Back to top](#table-of-contents)
|
||||
|
||||
- Just `lc` : Prints all directories, files and dotfiles in current directory.
|
||||
|
||||
|
|
@ -38,14 +49,18 @@ A Ruby script that colorizes the `ls` output with color and icons. Here are the
|
|||
|
||||
|
||||
|
||||
# Installation steps
|
||||
# Installation
|
||||
|
||||
[Back to top](#table-of-contents)
|
||||
|
||||
1. Install Ruby (prefably, version > 2.1)
|
||||
2. Install the patched fonts of powerline nerd-font and/or font-awesome.
|
||||
3. Install the [colorls](https://rubygems.org/gems/colorls/) ruby gem with `gem install colorls`
|
||||
4. Start using `lc` :tada:
|
||||
|
||||
# Tweaking the configurations
|
||||
# Optional configurations
|
||||
|
||||
[Back to top](#table-of-contents)
|
||||
|
||||
1. To add some flag options by default, add this to your shell configuration file (`~/.bashrc`, `~/.zshrc` or `~/.fishrc`) :
|
||||
```sh
|
||||
|
|
@ -59,24 +74,11 @@ subl $(gem which colorls)/../yaml/
|
|||
|
||||
_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
|
||||
# Uninstall
|
||||
|
||||
[Back to top](#table-of-contents)
|
||||
|
||||
Want to uninstall and revert back to the old style?
|
||||
```sh
|
||||
gem uninstall colorls
|
||||
```
|
||||
|
||||
# Tweaking this project
|
||||
|
||||
|
||||
|
||||
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 ruby scripts of the gem.
|
||||
- adding support for more icons by editing the [YAML files](lib/yaml/).
|
||||
|
||||
# LICENSE
|
||||
|
||||
MIT License 2017 - [Athitya Kumar](https://github.com/athityakumar/).
|
||||
|
|
|
|||
Loading…
Reference in a new issue