From a6d2ccbb226cddedf5dcd453ea9455ca97af9f7b Mon Sep 17 00:00:00 2001 From: siduck76 Date: Sat, 26 Jun 2021 12:33:02 +0530 Subject: [PATCH] Update README.md --- README.md | 72 ++++++++++++++++++++++++++++++------------------------- 1 file changed, 40 insertions(+), 32 deletions(-) diff --git a/README.md b/README.md index 1981f8d..1a088aa 100644 --- a/README.md +++ b/README.md @@ -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) [![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) +
+ Home + • + Install + • + Contribute + • + Support + • + Extras +

+
+ An attempt to make neovim (cli version) as functional as an IDE while being very eyecandy and less bloated. -# Screenshots - +

Screenshots

@@ -11,50 +24,48 @@ An attempt to make neovim (cli version) as functional as an IDE while being very
-# 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 :
-#### nvim-tree.lua +#### Nvim-tree.lua fast file tree :
-### telescope-nvim - +### Telescope-nvim A fuzzy file finder, picker, sorter, previewer and much more:
-### indent-blankline.nvim - +### Indent-blankline.nvim adds indentline : -### galaxyline - +### Galaxyline fastest statusline plugin I've used so far:
-
+### Nvim-bufferline.lua -### nvim-bufferline.lua - - -As a top bufferline like thing which lets me handle tabs like switching, closing tabs. +As a top tabline like thing which lets me handle tabs and buffers like switching , sorting and closing them etc. -
- -### nvim-web-devicons - +### Nvim-web-devicons + Lua fork of vim devicons which lets me change icons of filetypes -
- -### nvim-treesitter + + +### Nvim-treesitter + Better syntax highlighting for programming languages ( my config just has html,css,js support for now ). without / with Treesitter : @@ -63,14 +74,16 @@ without / with Treesitter : # Features - File navigation with Nvimtree -- mouse works -- managing tabs with bufferline +- Using plugins that are mouse friendly +- sexy themes +- managing tabs , buffers with bufferline - autosave - icons on nvimtree , telescope , bufferline/statusline and almost everywhere! with nvim-web-devicons - minimal status line ( galaxyline) - gitsigns (colored bars for git in my config) - using nvim-lsp - nvim-lspconfig for nvim-lps configuration +- lspInstall for installing lsp servers easily. - nvim-compe for autocompletion - lspkind to show pictograms on autocompletion items - telescope for file finding , picking , previewing (files and even images) @@ -82,17 +95,16 @@ without / with Treesitter : - smooth scrolling - Snip support from VSCode through vsnip supporting custom and predefined snips (friendly-snippets) -# Requirements +# Requirements - 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. # Wiki - [pre-requisite](https://github.com/siduck76/NvChad/wiki/Lua-guides) - [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) # TODO @@ -102,16 +114,17 @@ It would be nice if NvChad focuses on existing plugins and config before adding - Debloat the config - Add more themes. - 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!. -- 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 ) . -## :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. @@ -122,8 +135,3 @@ It is never required but always appreciated. undefined undefined

- -# Contact - - -- My linux / unix related ricing community: https://t.me/DE_WM (telegram) -- Me: @siduck (telegram)