Skip to content

Commit ee2d12b

Browse files
adrian5zwpaper
authored andcommitted
Update permission options in README; minor tweaks
1 parent 69b28bf commit ee2d12b

File tree

1 file changed

+13
-13
lines changed

1 file changed

+13
-13
lines changed

README.md

+13-13
Original file line numberDiff line numberDiff line change
@@ -120,7 +120,7 @@ These are usually something like `C:\Users\username\AppData\Roaming\lsd\config.y
120120

121121
### Custom
122122

123-
You can also provide a configuration file from a non standard location:
123+
You can also provide a configuration file from a non-standard location:
124124
`lsd --config-file [PATH]`
125125

126126
### Config file content
@@ -224,7 +224,7 @@ size: default
224224

225225
# == Permission ==
226226
# Specify the format of the permission column
227-
# Possible value: rwx, octal, attributes (windows only), disabled
227+
# Possible value: rwx, octal, attributes (windows only), disable
228228
# permission: rwx
229229

230230
# == Sorting ==
@@ -292,7 +292,7 @@ The valid theme configurations are:
292292

293293
- `default`: the default color scheme shipped in `lsd`
294294
- `custom`: use a custom color scheme defined in `colors.yaml`
295-
- *(deprecated) theme_file_name(yaml): use the theme file to specify colors(without the `yaml` extension)*
295+
- *(deprecated) theme_file_name(yaml): use the theme file to specify colors (without the `yaml` extension)*
296296

297297
When set to `custom`, `lsd` will look for `colors.yaml` in the
298298
XDG Base Directory, e.g. ~/.config/lsd/colors.yaml
@@ -359,7 +359,7 @@ git-status:
359359
```
360360

361361
When creating a theme for `lsd`, you can specify any part of the default theme,
362-
and then change its colors, the items missed would fallback to use the default colors.
362+
and then change its colors, the items missed would fall back to use the default colors.
363363

364364
Please also notice that an empty theme is **NOT** supported due to
365365
[a bug in serde lib](https://github.com/dtolnay/serde-yaml/issues/86).
@@ -380,7 +380,7 @@ Check [Icon Theme file content](#icon-theme-file-content) for details.
380380
The final set of icons used will be a combination of what is shipped with in `lsd` with overrides from config applied on top of it.
381381
*You can find the default set of icons [here](src/theme/icon.rs).*
382382

383-
Both nerd font glyphs and unicode emojis can be used for icons. You can find an example of icons customization below.
383+
Both nerd font glyphs and Unicode emojis can be used for icons. You can find an example of icons customization below.
384384

385385
```yaml
386386
name:
@@ -447,18 +447,18 @@ For `lsd` currently, it reads a system environment variable called LS_COLORS. Pl
447447

448448
### Icons not showing up
449449

450-
For `lsd` to be able to display icons, the font has to include special font glyphs. This might not be the case for most fonts that you download. Thankfully, you can patch most fonts using [NerdFont](https://www.nerdfonts.com/) and add these icons. Or you can just download an already patched version of your favourite font from [NerdFont font download page](https://www.nerdfonts.com/font-downloads).
451-
Here is a guide on how to setup fonts on [macOS](https://github.com/lsd-rs/lsd/issues/199#issuecomment-494218334) and [Android](https://github.com/lsd-rs/lsd/issues/423).
450+
For `lsd` to be able to display icons, the font has to include special font glyphs. This might not be the case for most fonts that you download. Thankfully, you can patch most fonts using [NerdFont](https://www.nerdfonts.com/) and add these icons. Or you can just download an already patched version of your favorite font from [NerdFont font download page](https://www.nerdfonts.com/font-downloads).
451+
Here is a guide on how to set up fonts on [macOS](https://github.com/lsd-rs/lsd/issues/199#issuecomment-494218334) and [Android](https://github.com/lsd-rs/lsd/issues/423).
452452

453-
To check if the font you are using is setup correctly, try running the following snippet in a shell and see if that [prints a folder icon](https://github.com/lsd-rs/lsd/issues/510#issuecomment-860000306). If it prints a box, or question mark or something else, then you might have some issues in how you setup the font or how your terminal emulator renders the font.
453+
To check if the font you are using is set up correctly, try running the following snippet in a shell and see if that [prints a folder icon](https://github.com/lsd-rs/lsd/issues/510#issuecomment-860000306). If it prints a box, or question mark or something else, then you might have some issues in how you set up the font or how your terminal emulator renders the font.
454454

455455
```sh
456456
echo $'\uf115'
457457
```
458458

459459
### Icons missing or not rendering correctly using PuTTY/KiTTY on Windows
460460

461-
First of all, make sure a patched font is installed and PuTTY/KiTTY is configurated to use it, please check [Prerequisites](#prerequisites).
461+
First of all, make sure a patched font is installed and PuTTY/KiTTY is configured to use it, please check [Prerequisites](#prerequisites).
462462

463463
There are problems for PuTTY/KiTTY to show 2 char wide icons, make sure using a 1 char wide font like [Hack Regular Nerd Font Complete Mono Windows Compatible](https://github.com/ryanoasis/nerd-fonts/blob/master/patched-fonts/Hack/Regular/complete/Hack%20Regular%20Nerd%20Font%20Complete%20Mono%20Windows%20Compatible.ttf), check [this issue](https://github.com/lsd-rs/lsd/issues/331) for detail.
464464

@@ -477,18 +477,18 @@ The default colors are:
477477
| | ![#d75f87](https://via.placeholder.com/15/d75f87/000000?text=+) No Access | ![#00d7d7](https://via.placeholder.com/15/00d7d7/000000?text=+) Pipe/Symlink/Blockdevice/Socket/Special | | |
478478
| | | ![#d78700](https://via.placeholder.com/15/d78700/000000?text=+) CharDevice | | |
479479

480-
_Checkout [trapd00r/LS_COLORS](https://github.com/trapd00r/LS_COLORS) and [sharkdp/vivid](https://github.com/sharkdp/vivid) for help in themeing using `LS_COLORS`._
480+
_Checkout [trapd00r/LS_COLORS](https://github.com/trapd00r/LS_COLORS) and [sharkdp/vivid](https://github.com/sharkdp/vivid) for help in theming using `LS_COLORS`._
481481

482482
### First char of folder/file getting trimmed
483483

484-
Workaround for Konsole: ㅤEdit the config file (or [create it](#config-file-location) if it doesn't already exist) and paste the following into it (contains invisible unicode characters):
484+
Workaround for Konsole: ㅤEdit the config file (or [create it](#config-file-location) if it doesn't already exist) and paste the following into it (contains invisible Unicode characters):
485485

486486
```yml
487487
icons:
488488
separator: " ㅤ"
489489
```
490490

491-
This is a known issue in a few terminal emulator. Try using a different terminal emulator like. [Alacritty](https://github.com/alacritty/alacritty) and [Kitty](https://github.com/kovidgoyal/kitty) are really good alternatives. You might also want to check if your font is responsible for causing this.
491+
This is a known issue in a few terminal emulators. Try using a different terminal emulator like. [Alacritty](https://github.com/alacritty/alacritty) and [Kitty](https://github.com/kovidgoyal/kitty) are really good alternatives. You might also want to check if your font is responsible for causing this.
492492
To verify this, try running lsd with icons disabled and if it still does not have the first character, then this is an lsd bug:
493493

494494
```sh
@@ -501,7 +501,7 @@ lsd --icon never --ignore-config
501501

502502
### Icons are showing up strangely
503503

504-
Nerd Fonts is moving the codepoints of the Material Design Icons in 3.0, so lsd has updated the icons in #830. If your icons look weird, use fonts that have been patched using Nerd Fonts v2.3.0 or later.
504+
Nerd Fonts is moving the code points of the Material Design Icons in 3.0, so lsd has updated the icons in #830. If your icons look weird, use fonts that have been patched using Nerd Fonts v2.3.0 or later.
505505

506506
See also: <https://github.com/ryanoasis/nerd-fonts/releases/tag/v2.3.3>
507507

0 commit comments

Comments
 (0)