Skip to content

Commit f36b926

Browse files
author
Ryan Delaney
committed
mdformat everything
1 parent 6e7be87 commit f36b926

File tree

2 files changed

+21
-13
lines changed

2 files changed

+21
-13
lines changed

CONTRIBUTING.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -7,5 +7,5 @@ The following is a set of guidelines for contributing to LS_COLORS
77
## Pull Request Process
88

99
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.
10-
2. Run tests
11-
3. Create a new pull request
10+
1. Run tests
11+
1. Create a new pull request

README.markdown

+19-11
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,14 @@
11
### Table of contents
2-
* [LS_COLORS](#ls_colors)
3-
* [What does it look like?](#what-does-it-look-like)
4-
* [Dependencies](#dependencies)
5-
* [Installation](#installation)
6-
* [Information for Developers](#information-for-developers)
7-
* [Legal](#legal)
2+
3+
- [LS_COLORS](#ls_colors)
4+
- [What does it look like?](#what-does-it-look-like)
5+
- [Dependencies](#dependencies)
6+
- [Installation](#installation)
7+
- [Information for Developers](#information-for-developers)
8+
- [Legal](#legal)
89

910
# LS_COLORS
11+
1012
This is a collection of extension:color mappings, suitable to use as your
1113
`LS_COLORS` environment variable. Most of them use the extended color map,
1214
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
2628
possible extensions, like htm and html, should have the same color.
2729

2830
# What does it look like?
31+
2932
Here's a screenshot _(font and minor color shades, of course, depend on terminal and its configuration)_:
3033

3134
![Screenshot1](docs/static/LS_COLORS.png)
3235

33-
[0]: https://github.com/trapd00r/zsh-syntax-highlighting-filetypes
34-
[1]: https://github.com/trapd00r/File-LsColor
35-
[2]: https://github.com/trapd00r/File-LsColor/tree/master/bin
36-
[3]: https://aur.archlinux.org/packages/lscolors-git
37-
3836
# Dependencies
3937

4038
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
4745
To enable the colors, add the following line to your shell's start-up script:
4846

4947
For Bourne shell (e.g. `~/.bashrc` or `~/.zshrc`):
48+
5049
```
5150
source ~/path/to/lscolors.sh
5251
```
5352

5453
For C shell (e.g. `~/.cshrc`):
54+
5555
```
5656
source ~/path/to/lscolors.csh
5757
```
@@ -72,14 +72,17 @@ $
7272
```
7373

7474
## Arch Linux
75+
7576
Arch Linux users can install the [`lscolors-git`][3] package from the AUR for easy
7677
integration with bash, csh, or zsh.
7778

7879
# Information for Developers
80+
7981
There's a [library][1] I've written that lets you use various LS COLORS on
8082
arbitrary files and directories. A simple implementation can be found [here][2].
8183

8284
Using this, you can do
85+
8386
```shell
8487
find $HOME -maxdepth 1 | ls_color
8588

@@ -89,6 +92,7 @@ mpc search artist Laleh | ls_color
8992
... and so on.
9093

9194
# Legal
95+
9296
© Copyright 2014-2022 Magnus Woldrich.
9397

9498
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.
101105

102106
You should have received a copy of the Perl Artistic License along
103107
with this program. If not, see <http://www.perlfoundation.org/artistic_license_1_0>.
108+
109+
[1]: https://github.com/trapd00r/File-LsColor
110+
[2]: https://github.com/trapd00r/File-LsColor/tree/master/bin
111+
[3]: https://aur.archlinux.org/packages/lscolors-git

0 commit comments

Comments
 (0)