Update README.md

This commit is contained in:
siduck76 2021-06-26 12:33:02 +05:30 committed by GitHub
parent 3e1cf53fd6
commit a6d2ccbb22
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 40 additions and 32 deletions

View File

@ -1,9 +1,22 @@
[![Super-Linter](https://github.com/siduck76/NvChad/actions/workflows/superLinter.yml/badge.svg)](https://github.com/siduck76/NvChad/actions/workflows/superLinter.yml) [![Super-Linter](https://github.com/siduck76/NvChad/actions/workflows/superLinter.yml/badge.svg)](https://github.com/siduck76/NvChad/actions/workflows/superLinter.yml)
[![Gitter](https://badges.gitter.im/neovim-dotfiles/community.svg)](https://gitter.im/neovim-dotfiles/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge) [![Gitter](https://badges.gitter.im/neovim-dotfiles/community.svg)](https://gitter.im/neovim-dotfiles/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
<div align="center">
<a href="https://github.com/siduck76/NvChad/wiki#clone-my-setup">Home</a>
<span></span>
<a href="https://github.com/siduck76/NvChad/wiki#clone-my-setup">Install</a>
<span></span>
<a href="https://github.com/siduck76/NvChad#contribute">Contribute</a>
<span></span>
<a href="https://github.com/siduck76/NvChad#gift_heart--support">Support</a>
<span></span>
<a href="https://github.com/siduck76/NvChad/wiki/Chad-user-configs">Extras</a>
<p></p>
</div>
An attempt to make neovim (cli version) as functional as an IDE while being very eyecandy and less bloated. An attempt to make neovim (cli version) as functional as an IDE while being very eyecandy and less bloated.
# Screenshots - <center> <h2>Screenshots</h2> </center>
<img src ="https://raw.githubusercontent.com/siduck76/dotfiles/master/rice%20flex/dashboard-nvim.png"><hr> <img src ="https://raw.githubusercontent.com/siduck76/dotfiles/master/rice%20flex/dashboard-nvim.png"><hr>
<img src ="https://raw.githubusercontent.com/siduck76/dotfiles/master/rice%20flex/initialNvim1.png"><hr> <img src ="https://raw.githubusercontent.com/siduck76/dotfiles/master/rice%20flex/initialNvim1.png"><hr>
@ -11,50 +24,48 @@ An attempt to make neovim (cli version) as functional as an IDE while being very
<img src ="https://raw.githubusercontent.com/siduck76/dotfiles/master/rice%20flex/nvimRice2.png"><hr> <img src ="https://raw.githubusercontent.com/siduck76/dotfiles/master/rice%20flex/nvimRice2.png"><hr>
<img src ="https://cdn.discordapp.com/attachments/610012460828852229/853933487295299584/unknown.png"><hr> <img src ="https://cdn.discordapp.com/attachments/610012460828852229/853933487295299584/unknown.png"><hr>
# Very Useful lua plugins used in my config - # Very Very Useful lua plugins used in my config
#### lspkind-nvim #### Lspkind-nvim
This tiny plugin adds vscode-like pictograms to neovim built-in lsp completion items : This tiny plugin adds vscode-like pictograms to neovim built-in lsp completion items :
<kbd><img src = "https://raw.githubusercontent.com/siduck76/dotfiles/master/rice%20flex/lspkind.png"></kbd><hr> <kbd><img src = "https://raw.githubusercontent.com/siduck76/dotfiles/master/rice%20flex/lspkind.png"></kbd><hr>
#### nvim-tree.lua #### Nvim-tree.lua
fast file tree : fast file tree :
<kbd><img src = "https://raw.githubusercontent.com/siduck76/dotfiles/master/rice%20flex/nvimtree.png"></kbd><hr> <kbd><img src = "https://raw.githubusercontent.com/siduck76/dotfiles/master/rice%20flex/nvimtree.png"></kbd><hr>
### telescope-nvim - ### Telescope-nvim
A fuzzy file finder, picker, sorter, previewer and much more: A fuzzy file finder, picker, sorter, previewer and much more:
<kbd> <img src = "https://raw.githubusercontent.com/siduck76/dotfiles/master/rice%20flex/tel.png"></kbd> <kbd> <img src = "https://raw.githubusercontent.com/siduck76/dotfiles/master/rice%20flex/tel.png"></kbd>
<kbd> <img src = "https://raw.githubusercontent.com/siduck76/dotfiles/master/rice%20flex/telmedia.png"></kbd><hr> <kbd> <img src = "https://raw.githubusercontent.com/siduck76/dotfiles/master/rice%20flex/telmedia.png"></kbd><hr>
### indent-blankline.nvim - ### Indent-blankline.nvim
adds indentline : adds indentline :
<kbd> <img src = "https://raw.githubusercontent.com/siduck76/dotfiles/master/rice%20flex/blanklineNvim.png"></kbd> <kbd> <img src = "https://raw.githubusercontent.com/siduck76/dotfiles/master/rice%20flex/blanklineNvim.png"></kbd>
### galaxyline - ### Galaxyline
fastest statusline plugin I've used so far: fastest statusline plugin I've used so far:
<kbd><img src = "https://raw.githubusercontent.com/siduck76/dotfiles/master/rice%20flex/statusline.png"></kbd><hr> <kbd><img src = "https://raw.githubusercontent.com/siduck76/dotfiles/master/rice%20flex/statusline.png"></kbd><hr>
<hr> ### Nvim-bufferline.lua
### nvim-bufferline.lua - As a top tabline like thing which lets me handle tabs and buffers like switching , sorting and closing them etc.
As a top bufferline like thing which lets me handle tabs like switching, closing tabs.
<kbd> <img src = "https://raw.githubusercontent.com/siduck76/dotfiles/master/rice%20flex/bufferline.png"></kbd> <kbd> <img src = "https://raw.githubusercontent.com/siduck76/dotfiles/master/rice%20flex/bufferline.png"></kbd>
<hr> ### Nvim-web-devicons
### nvim-web-devicons -
Lua fork of vim devicons which lets me change icons of filetypes Lua fork of vim devicons which lets me change icons of filetypes
<kbd> <img src = "https://raw.githubusercontent.com/siduck76/dotfiles/master/rice%20flex/image.png"></kbd><hr> <kbd> <img src = "https://raw.githubusercontent.com/siduck76/dotfiles/master/rice%20flex/image.png"></kbd>
### nvim-treesitter ### Nvim-treesitter
Better syntax highlighting for programming languages ( my config just has html,css,js support for now ). Better syntax highlighting for programming languages ( my config just has html,css,js support for now ).
without / with Treesitter : without / with Treesitter :
@ -63,14 +74,16 @@ without / with Treesitter :
# Features # Features
- File navigation with Nvimtree - File navigation with Nvimtree
- mouse works - Using plugins that are mouse friendly
- managing tabs with bufferline - sexy themes
- managing tabs , buffers with bufferline
- autosave - autosave
- icons on nvimtree , telescope , bufferline/statusline and almost everywhere! with nvim-web-devicons - icons on nvimtree , telescope , bufferline/statusline and almost everywhere! with nvim-web-devicons
- minimal status line ( galaxyline) - minimal status line ( galaxyline)
- gitsigns (colored bars for git in my config) - gitsigns (colored bars for git in my config)
- using nvim-lsp - using nvim-lsp
- nvim-lspconfig for nvim-lps configuration - nvim-lspconfig for nvim-lps configuration
- lspInstall for installing lsp servers easily.
- nvim-compe for autocompletion - nvim-compe for autocompletion
- lspkind to show pictograms on autocompletion items - lspkind to show pictograms on autocompletion items
- telescope for file finding , picking , previewing (files and even images) - telescope for file finding , picking , previewing (files and even images)
@ -82,17 +95,16 @@ without / with Treesitter :
- smooth scrolling - smooth scrolling
- Snip support from VSCode through vsnip supporting custom and predefined snips (friendly-snippets) - Snip support from VSCode through vsnip supporting custom and predefined snips (friendly-snippets)
# Requirements # Requirements
- neovim 0.5 - neovim 0.5
- A terminal that supports [nerdfonts](https://github.com/ryanoasis/nerd-fonts) - A terminal that supports [nerdfonts](https://github.com/ryanoasis/nerd-fonts)
- Set terminal's inner padding to 0. - Set terminal's inner padding to 0.
# Wiki # Wiki
- [pre-requisite](https://github.com/siduck76/NvChad/wiki/Lua-guides) - [pre-requisite](https://github.com/siduck76/NvChad/wiki/Lua-guides)
- [config-structure](https://github.com/siduck76/NvChad/wiki#config-structure) - [config-structure](https://github.com/siduck76/NvChad/wiki#config-structure)
- [Install](https://github.com/siduck76/NvChad/wiki#clone-my-setup)
- [mappings](https://github.com/siduck76/NvChad/wiki/mappings) - [mappings](https://github.com/siduck76/NvChad/wiki/mappings)
# TODO # TODO
@ -102,16 +114,17 @@ It would be nice if NvChad focuses on existing plugins and config before adding
- Debloat the config - Debloat the config
- Add more themes. - Add more themes.
- Add a theme switcher. - Add a theme switcher.
- Add a global configuration so it doesnt get hard to update :c - Preview shortcuts in the form of a pretty [cheatsheet](https://user-images.githubusercontent.com/59060246/122490009-95fd9980-cffe-11eb-9676-78019aa2cd65.png)
- Add a global configuration so it doesnt get hard to update :c
# Contibute # Contribute
- PR's are always welcomed however NvChad aims to be less bloated and suckless. So PR's regarding existing plugin's enhancement , bug fixes are more encouraged. - PR's are always welcomed however NvChad aims to be less bloated and suckless. So PR's regarding existing plugin's enhancement , bug fixes are more encouraged.
- PR's regarding adding new plugins and their configs must be given some thought since NvChad aims to have a minimal config and meant to be used as a "base" neovim config so it will have only a set of important plugins. So adding more and more plugins, making NvChad bloated + slow wont help!. - PR's regarding adding new plugins and their configs must be given some thought since NvChad aims to have a minimal config and meant to be used as a "base" neovim config so it will have only a set of important plugins. So adding more and more plugins, making NvChad bloated + slow wont help!.
- NvChad isnt a Framework. NvChad wont keep adding more and more features ( adding new plugins most likely) as requested , no spoonfeeding!! If you think the plugin you want to be added is very useful and many NvChaders would find it useful, then such feature's PR is welcomed! - NvChad isnt a Framework. NvChad wont keep adding more and more features ( adding new plugins most likely) as requested , no spoonfeeding!! If you think the plugin you want to be added is very useful and many NvChaders would find it useful, then such feature's PR is welcomed!
- But adding specific features like adding config for https://github.com/wakatime/vim-wakatime etc will be added in this https://github.com/siduck76/NvChad/wiki/Chad-user-configs. This lets the user select the things only they want ( from extra configs ) . - But adding specific features like adding config for https://github.com/wakatime/vim-wakatime etc will be added in this https://github.com/siduck76/NvChad/wiki/Chad-user-configs. This lets the user select the things only they want ( from extra configs ) .
## :gift_heart: Support ## :gift_heart: Support
If you enjoy using NvChad and would like to show your appreciation, you may want to tip me here. If you enjoy using NvChad and would like to show your appreciation, you may want to tip me here.
@ -122,8 +135,3 @@ It is never required but always appreciated.
<a href="https://ko-fi.com/siduck76" target="_blank"><img alt="undefined" width="48px" src="https://raw.githubusercontent.com/adi1090x/files/master/other/2.png"></a> <a href="https://ko-fi.com/siduck76" target="_blank"><img alt="undefined" width="48px" src="https://raw.githubusercontent.com/adi1090x/files/master/other/2.png"></a>
<a href="https://www.paypal.com/paypalme/siduck76" target="_blank"><img alt="undefined" width="48px" src="https://raw.githubusercontent.com/adi1090x/files/master/other/3.png"></a> <a href="https://www.paypal.com/paypalme/siduck76" target="_blank"><img alt="undefined" width="48px" src="https://raw.githubusercontent.com/adi1090x/files/master/other/3.png"></a>
</p> </p>
# Contact -
- My linux / unix related ricing community: https://t.me/DE_WM (telegram)
- Me: @siduck (telegram)