Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.markdown #221

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update README.markdown #221

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 5 additions & 7 deletions README.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,11 +15,9 @@
<!-- mdformat-toc end -->

This is a collection of extension:color mappings, suitable to use as your
`LS_COLORS` environment variable. Most of them use the extended color map,
described in the ECMA-48 document; in other words, you'll need a terminal
with capabilities of displaying 256 colors.
`LS_COLORS` environment variable. Most of them use the extended color map (described in the [ECMA-48](https://ecma-international.org/publications-and-standards/standards/ecma-48)); in other words—you'll need a terminal with capabilities of displaying 256 colors.

As of this writing, around 300 different filetypes/extensions is supported.
As of this writing, around 300 different filetypes/extensions are supported.
That's indeed a lot of extensions, but there's a lot more! Your help is greatly
appreciated.

Expand All @@ -41,21 +39,21 @@ Here's a screenshot _(font and minor color shades, of course, depend on terminal
## Dependencies

You need GNU `dircolors` and a compatible directory listing tool, such as GNU
`ls`. Both are available in GNU coreutils.
`ls`. Both are available in GNU `coreutils`.

## Installation

The repo contains two compiled scripts `lscolors.sh` & `lscolors.csh`, which you can download & source directly or point your plugin manager to pick up one of them.

To enable the colors, add the following line to your shell's start-up script:

For Bourne shell (e.g. `~/.bashrc` or `~/.zshrc`):
**For Bourne shell** (e.g. `~/.bashrc` or `~/.zshrc`):

```
source ~/path/to/lscolors.sh
```

For C shell or [fish shell](https://fishshell.com/) (e.g. `~/.cshrc` or `~/.config/fish/config.fish`):
**For C shell or [fish shell](https://fishshell.com/)** (e.g. `~/.cshrc` or `~/.config/fish/config.fish`):

```
source ~/path/to/lscolors.csh
Expand Down