|
2 | 2 |
|
3 | 3 | > k is the new l, yo |
4 | 4 |
|
5 | | -## Repos |
| 5 | +k is a zsh script to make directory listings more readable, adding a bit of color and some git information. |
6 | 6 |
|
7 | | -Turns boring direcory listing of your git repos from this: |
| 7 | +## Repo markers on directory listings |
| 8 | +Red for dirty, green for committed. |
| 9 | + |
| 10 | +Turns this: |
8 | 11 |  |
9 | 12 |
|
10 | | -Into this: |
11 | | - |
| 13 | +Into this: |
| 14 | + |
12 | 15 |
|
13 | | -### Usage |
14 | | -hit k, just like you would l (or ls) |
| 16 | +## Git status on files with a working tree |
| 17 | +Red for dirty, green for committed, orange for untracked, grey for ingored. |
| 18 | + |
| 19 | +Turns this: |
| 20 | + |
| 21 | + |
| 22 | +Into this: |
| 23 | + |
| 24 | + |
| 25 | +## File weight colours |
| 26 | +Files sizes are graded from green for small (< 1k), to red for huge (> 1mb). |
| 27 | + |
| 28 | +Turns this: |
| 29 | + |
| 30 | + |
| 31 | +Into this: |
| 32 | + |
15 | 33 |
|
16 | | -```shell |
17 | | -k |
18 | | -``` |
19 | 34 |
|
20 | | -### Installation |
| 35 | +## Usage |
21 | 36 | Put `k.sh` somewhere, and source it in your `.zshrc`. |
22 | 37 |
|
23 | 38 | ```shell |
24 | 39 | source ~/path-to/k/k.sh |
25 | 40 | ``` |
26 | 41 |
|
27 | | -### Thanks |
28 | | -ZSH Team |
29 | | -BSD Team |
30 | | -[Robby Russell](https://github.com/robbyrussell) for making the shell fun with oh my zsh |
31 | | -[Sindre Sorhus](https://github.com/sindresorhus) for fast git commands from Z pure theme |
32 | | -[Rupa](https://github.com/rupa/z) for that slammin' strapline |
| 42 | +hit k |
| 43 | + |
| 44 | +```shell |
| 45 | +k |
| 46 | +``` |
| 47 | + |
| 48 | +profit |
| 49 | + |
| 50 | +## Thanks |
| 51 | +zsh Team |
| 52 | +[Robby Russell](https://github.com/robbyrussell) for making the shell fun with oh my zsh |
| 53 | +[Sindre Sorhus](https://github.com/sindresorhus) for fast git commands from zsh pure theme |
| 54 | +[Rupa](https://github.com/rupa/z) for that slammin' strapline |
| 55 | + |
| 56 | +## Contributing |
| 57 | +Pull requests welcome. |
| 58 | + |
| 59 | +MIT License |
0 commit comments