From 92207b4495e92c6e78ab6f530094bd18c48aad8a Mon Sep 17 00:00:00 2001
From: Alok <73450969+alok8bb@users.noreply.github.com>
Date: Sun, 14 Mar 2021 22:18:48 +0530
Subject: [PATCH] Update README.md
This is how I would like it to be ;)
Change things you don't like (like those `-` on headers)
---
README.md | 64 +++++++++++++++++++++++++++++++++----------------------
1 file changed, 38 insertions(+), 26 deletions(-)
diff --git a/README.md b/README.md
index ed00ac0..086acbd 100644
--- a/README.md
+++ b/README.md
@@ -1,43 +1,56 @@
-The config is complete but still WIP as Im new to lua and slowly learning vim stuffs , so I'll keep adding new features like snippets etc and clean the config!
-# Screenshots
+The config is complete but still work in progress as I am new to lua and slowly learning vim stuffs, so I'll keep adding new features like snippets etc and clean the config!
- 
-
+# Screenshots -
-# Some VERY COOL lua plugins I use
+
+
-- nvim-lspkind , for showing lil icons/pictograms on completion items
- 
+# Cool Plugins -
+
+#### lspkind-nvim
+This tiny plugin adds vscode-like pictograms to neovim built-in lsp:
+
+
-- nvim-tree.lua , a fast file tree
- 
+#### nvim-tree.lua
+A fast and efficient file tree:
+
+
-- telescope-nvim , a fuzzy file finder , picker , sorter , previewer and much more!
+### telescope-nvim -
+A fuzzy file finder, picker, sorter, previewer and much more:
- 
+
-- galaxyline , a statusline plugin
- 
+### galaxyline -
+A statusline plugin:
+
-- gitsigns.nvim , to show git signs of a repo on the signcolumn to indicate diffs/changes etc (needs plenary.nvim)
+### gitsigns.nvim -
+Shows git signs of a repo on the signcolumn to indicate diffs/changes etc (needs plenary.nvim)
+
-- nvim-bufferline.lua , as a top bufferline like thing which lets me handle tabs like switching , closing tabs.
+### nvim-bufferline.lua -
+As a top bufferline like thing which lets me handle tabs like switching, closing tabs.
+
-- nvim-web-devicons , lua fork of vim devicons which lets me change icons of filetypes
- 
+### nvim-web-devicons -
+Lua fork of vim devicons which lets me change icons of filetypes
+
-- nvim-treesitter , better syntax highlighting for programming languages ( my config just has html,css,js support for now ).
+### nvim-treesitter
+Better syntax highlighting for programming languages ( my config just has html,css,js support for now ).
- without Treesitter
+ without Treesitter :
- with Treesitter
- 
+ with Treesitter :
+
-# Some guides to migrate to init.lua!
+# Guides to migrate to init.lua -
- https://github.com/nanotee/nvim-lua-guide
@@ -48,7 +61,7 @@ The config is complete but still WIP as Im new to lua and slowly learning vim st
- https://icyphox.sh/blog/nvim-lua/
-# Clone my setup
+# Clone my setup -
- Install neovim-nightly , also use a nerdfont on your terminal.
- Install packer.nvim
@@ -77,11 +90,10 @@ git clone https://github.com/wbthomason/packer.nvim\
I'd install it first and add its setup line ( require'lspconfig'.clangd.setup{} ) in /lua/nvim-lspconfig/lua.lua file . I will organise the config slowly and soon add a list of important mappings used in my config , on this readme so it might get easy for some :)
- # Troubleshooting
+ # Troubleshooting -
if you get any errors with packer.nvim , then remove the ~/.config/nvim/plugin/packer_nvim.vim file since it just has file paths for my system
-and re-install packer.nvim
-
+and re-install packer.nvim