Sitelet https://github.com/nvim-tree/nvim-web-devicons/pull/517
Skip to content

docs(#516): README: full description - #517

Merged
alex-courtis merged 2 commits into
masterfrom
doc-full-description
Dec 7, 2024
Merged

alex-courtis merged 2 commits into
masterfrom
doc-full-description

Conversation

@alex-courtis

Copy link
Copy Markdown
Member

fixes #516

@alex-courtis
alex-courtis requested a review from hasecilu December 6, 2024 00:41
@alex-courtis alex-courtis changed the title doc(#516): README: full description docs(#516): README: full description Dec 6, 2024
@hasecilu

hasecilu commented Dec 6, 2024

Copy link
Copy Markdown
Collaborator

Also would be good to update the About and add mote tags, maybe: icons, neovim, lua, plugin

image

@alex-courtis

alex-courtis commented Dec 6, 2024 •

Copy link
Copy Markdown
Member Author

Great idea!

How does that look?

@alex-courtis alex-courtis reopened this Dec 6, 2024
@MoltenMonster

Copy link
Copy Markdown

@alex-courtis So far it looks good, but does the plugin provide all nerd font icons and overrides? If not then I think the readme should state that.

@alex-courtis

Copy link
Copy Markdown
Member Author

@alex-courtis So far it looks good, but does the plugin provide all nerd font icons and overrides? If not then I think the readme should state that.

Maybe some better phrasing.

The icons it provides by default are a subset of nerd fonts. You can override with whatever you please.

Proposed about:

Provides icons (glyphs) for use by neovim plugins. Nerd Font icons are provided for a set of file extensions and names.

@hasecilu

hasecilu commented Dec 6, 2024

Copy link
Copy Markdown
Collaborator

Provides Nerd Font1 icons (glyphs) associations with filetypes for use by Neovim plugins.

Footnotes

  1. Not limited to use Nerd Font icons, there is even a Unicode glyph used, even there are people that have custom fonts ↩

@hasecilu

hasecilu commented Dec 7, 2024

Copy link
Copy Markdown
Collaborator

@alex-courtis So far it looks good, but does the plugin provide all nerd font icons and overrides? If not then I think the readme should state that.

I don't think that's important, I think it's evident that not all filetypes and filenames will be covered, certainly is desirable. Not even Nerd Fonts has a list of filetypes/filenames they "just" gather the fonts, actually this project is one of the most complete projects with icons associations and to really achieve the "complete set of overrides" would be needed the help of lot of people, meanwhile I have a small change in progress.

@alex-courtis

Copy link
Copy Markdown
Member Author

Updated. Many thanks!

@alex-courtis
alex-courtis merged commit 2141721 into master Dec 7, 2024
@alex-courtis
alex-courtis deleted the doc-full-description branch December 7, 2024 03:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

The repo description should state what the plugin does rather than just stating its a fork

3 participants