mirror of
https://github.com/trapd00r/LS_COLORS.git
synced 2024-12-21 13:22:12 +01:00
mdformat everything
This commit is contained in:
parent
6e7be87749
commit
f36b926653
2 changed files with 21 additions and 13 deletions
|
@ -7,5 +7,5 @@ The following is a set of guidelines for contributing to LS_COLORS
|
|||
## Pull Request Process
|
||||
|
||||
1. Add the new file extension and its color to [`LS_COLORS`](./LS_COLORS). Try to find the most appropriate category for the file type and match the style to the others in the same category.
|
||||
2. Run tests
|
||||
3. Create a new pull request
|
||||
1. Run tests
|
||||
1. Create a new pull request
|
||||
|
|
|
@ -1,12 +1,14 @@
|
|||
### Table of contents
|
||||
* [LS_COLORS](#ls_colors)
|
||||
* [What does it look like?](#what-does-it-look-like)
|
||||
* [Dependencies](#dependencies)
|
||||
* [Installation](#installation)
|
||||
* [Information for Developers](#information-for-developers)
|
||||
* [Legal](#legal)
|
||||
|
||||
- [LS_COLORS](#ls_colors)
|
||||
- [What does it look like?](#what-does-it-look-like)
|
||||
- [Dependencies](#dependencies)
|
||||
- [Installation](#installation)
|
||||
- [Information for Developers](#information-for-developers)
|
||||
- [Legal](#legal)
|
||||
|
||||
# LS_COLORS
|
||||
|
||||
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
|
||||
|
@ -26,15 +28,11 @@ try to pick colors that fits in nicely together. Filetypes with multiple
|
|||
possible extensions, like htm and html, should have the same color.
|
||||
|
||||
# What does it look like?
|
||||
|
||||
Here's a screenshot _(font and minor color shades, of course, depend on terminal and its configuration)_:
|
||||
|
||||
![Screenshot1](docs/static/LS_COLORS.png)
|
||||
|
||||
[0]: https://github.com/trapd00r/zsh-syntax-highlighting-filetypes
|
||||
[1]: https://github.com/trapd00r/File-LsColor
|
||||
[2]: https://github.com/trapd00r/File-LsColor/tree/master/bin
|
||||
[3]: https://aur.archlinux.org/packages/lscolors-git
|
||||
|
||||
# Dependencies
|
||||
|
||||
You need GNU `dircolors` and a compatible directory listing tool, such as GNU
|
||||
|
@ -47,11 +45,13 @@ The repo contains two compiled scripts `lscolors.sh` & `lscolors.csh`, which you
|
|||
To enable the colors, add the following line to your shell's start-up script:
|
||||
|
||||
For Bourne shell (e.g. `~/.bashrc` or `~/.zshrc`):
|
||||
|
||||
```
|
||||
source ~/path/to/lscolors.sh
|
||||
```
|
||||
|
||||
For C shell (e.g. `~/.cshrc`):
|
||||
|
||||
```
|
||||
source ~/path/to/lscolors.csh
|
||||
```
|
||||
|
@ -72,14 +72,17 @@ $
|
|||
```
|
||||
|
||||
## Arch Linux
|
||||
|
||||
Arch Linux users can install the [`lscolors-git`][3] package from the AUR for easy
|
||||
integration with bash, csh, or zsh.
|
||||
|
||||
# Information for Developers
|
||||
|
||||
There's a [library][1] I've written that lets you use various LS COLORS on
|
||||
arbitrary files and directories. A simple implementation can be found [here][2].
|
||||
|
||||
Using this, you can do
|
||||
|
||||
```shell
|
||||
find $HOME -maxdepth 1 | ls_color
|
||||
|
||||
|
@ -89,6 +92,7 @@ mpc search artist Laleh | ls_color
|
|||
... and so on.
|
||||
|
||||
# Legal
|
||||
|
||||
© Copyright 2014-2022 Magnus Woldrich.
|
||||
|
||||
This program is distributed in the hope that it will be useful, but WITHOUT ANY
|
||||
|
@ -101,3 +105,7 @@ either version 1.0 of the License, or (at your option) any later version.
|
|||
|
||||
You should have received a copy of the Perl Artistic License along
|
||||
with this program. If not, see <http://www.perlfoundation.org/artistic_license_1_0>.
|
||||
|
||||
[1]: https://github.com/trapd00r/File-LsColor
|
||||
[2]: https://github.com/trapd00r/File-LsColor/tree/master/bin
|
||||
[3]: https://aur.archlinux.org/packages/lscolors-git
|
||||
|
|
Loading…
Reference in a new issue