rootiest/neovim-config
1
0
Fork 0
Code Issues Pull Requests 1 Actions Packages Projects Releases Wiki Activity

📝 docs(readme): add screenshots, update image links and features

Browse Source 
Add a Screenshots section. Update image links to use proper syntax and relative paths where possible. Update some features and add lualine features to docs.
This commit is contained in:
rootiest
2024-08-04 03:28:34 -04:00
parent 0b9d2ac853
commit 07f7707e67
1 changed files with 61 additions and 26 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+45 -10
View File
@@ -1,9 +1,8 @@
# Rootiest NeoVim Configuration # Rootiest NeoVim Configuration
<a href="https://dotfyle.com/rootiest/rootiest-nvim"><img src="https://dotfyle.com/rootiest/rootiest-nvim/badges/plugins?style=flat" /></a> [![Plugins](https://dotfyle.com/rootiest/rootiest-nvim/badges/plugins?style=flat)](https://dotfyle.com/rootiest/rootiest-nvim)
<a href="https://dotfyle.com/rootiest/rootiest-nvim"><img src="https://dotfyle.com/rootiest/rootiest-nvim/badges/leaderkey?style=flat" /></a> [![Leaderkey](https://dotfyle.com/rootiest/rootiest-nvim/badges/leaderkey?style=flat)](https://dotfyle.com/rootiest/rootiest-nvim)
<a href="https://dotfyle.com/rootiest/rootiest-nvim"><img src="https://dotfyle.com/rootiest/rootiest-nvim/badges/plugin-manager?style=flat" /></a> [![Plugin Manager](https://dotfyle.com/rootiest/rootiest-nvim/badges/plugin-manager?style=flat)](https://dotfyle.com/rootiest/rootiest-nvim)
```none ```none
██████╗ ██████╗ ██████╗ ████████╗██╗███████╗███████╗████████╗ ██████╗ ██████╗ ██████╗ ████████╗██╗███████╗███████╗████████╗
@@ -53,7 +52,7 @@ The rootiest neovim configuration you will ever see!
- [Nerd Fonts](https://github.com/ryanoasis/nerd-fonts/) - - [Nerd Fonts](https://github.com/ryanoasis/nerd-fonts/) -
Font with extended glyphs Font with extended glyphs
Your terminal/client application ***must*** have a Nerd Font installed Your terminal/client application **_must_** have a Nerd Font installed
and support the Nerd Font glyphs. and support the Nerd Font glyphs.
Kitty or NeoVide are recommended. Kitty or NeoVide are recommended.
@@ -125,19 +124,55 @@ without replacing your current NeoVim configuration.
- Kitty scrollback and keybinding support - Kitty scrollback and keybinding support
- Special configuration for neovide - Special configuration for neovide
- Detects terminal client and adjusts accordingly - Detects terminal client and adjusts accordingly
- ToggleTerm, fzf, telescope, neotree, etc. for quick access to files and terminal - ToggleTerm, fzf-lua, neotree, etc. for quick access to files and terminal
- Many UI elements to enhance the experience - Many UI elements to enhance the experience
- LSP support for many languages and automatic setup for many more - LSP support for many languages and automatic setup for many more
- Remotely spawn a NeoVim instance over ssh, in a container, or from a git repo - Remotely spawn a NeoVim instance over ssh, in a container, or from a git repo
- Dashboard logo adjusts to the size of the window - Dashboard logo adjusts to the size of the windowa
- Warnings for missing dependencies - Beautiful, unique, and feature-rich lualine statusline
- When available, git-blame, WakaTime and music player stats components displayed
in lualine ![Lualine](.screenshots/lualine.png)
- Warning system for missing dependencies
- User-selected AI completion tool: - User-selected AI completion tool:
`codeium`, `copilot`, `tabnine`, `minuet`, or `none` `codeium`, `copilot`, `tabnine`, `minuet`, or `none`
- WakaTime integration: Tracking time spent on code - WakaTime integration: Tracking time spent on code
- Hardtime integration: Trains better use of vim motions and shortcuts - Hardtime integration: Trains better use of vim motions and shortcuts
- Colorscheme is remembered between sessions - Colorscheme is remembered between sessions with [astral.nvim](https://github.com/rootiest/astral.nvim)
- Highlight group customizations that are colorscheme-compliant
- Lean and fast while providing a complete professional experience - Lean and fast while providing a complete professional experience
- Achieves sub-75ms startup time on my laptop - Achieves sub-75ms startup time on my personal laptop, goal to never exceed 100ms
## Screenshots
Features and
<details>
<summary>Main NeoVim PDE</summary>
![NeoVim UI](.screenshots/nvim-ui.png)
</details>
<details>
<summary>Dashboard</summary>
![NeoVim Dashboard](.screenshots/dashboard.png)
</details>
<details>
<summary>Markdown view with inline images</summary>
![NeoVim Markdown](.screenshots/markdown.png)
</details>
<details>
<summary>Neovide Transparency</summary>
![NeoVide Features](.screenshots/neovide.png)
</details>
## Options ## Options