From 3c5884ee4a0ad9b812e12004de9f079dc343cdd1 Mon Sep 17 00:00:00 2001 From: Oliver Ladner Date: Tue, 21 Nov 2023 13:29:49 +0100 Subject: [PATCH] documentation --- README.md | 28 ++++++++++++++++++++-------- init.lua | 7 ++----- 2 files changed, 22 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index e5528f5..bf24ad1 100644 --- a/README.md +++ b/README.md @@ -3,17 +3,21 @@ ## Motivation After doing my first steps with , -I decided to roll my own, custom, "lightweight" Neovim configuration in order to: +I decided to roll my own, custom, "lightweight" Neovim configuration in order to +better understand Neovim and its configuration/customization, package managers, +LSP etc. and have "my own" config that only includes things I really need. -- better understand Neovim and configuration/customization, package managers, LSP etc. -- Have "my own" config that only includes things I really need +## Installation -## Benefits for other people? +1. Install Neovim 0.9.x +1. Install OS dependencies documented in `init.lua` +1. Clone this Git repository to `~/.config/nvim` -Not sure if there are any, but I added comments where I -thought they are necessary. -`init.lua` documents any needed external dependencies. +### Finishing touches + +- Install Treesitter comment parser (to highlight `FIXME:/NOTE:/TODO:/XXX:`) with `:TSInstall comment` +- Create a `$HOME/.ignore` file and add big, useless directories to it, so Telescope/ripgrep/fd can ignore those. Details in `lua/weeheavy/plugins/telescope-fzf-native.lua` ## Speed @@ -71,7 +75,7 @@ This is more accurate than `nvim --startuptime`. ### Telescope -#### File search +#### Telescope file search - `Ctrl+n` scroll down (**n**ext) file list - `Ctrl+p` scroll up (**p**revious) file list @@ -81,3 +85,11 @@ This is more accurate than `nvim --startuptime`. ### Treesitter - `:TSUpdate` update all parsers +- `:TSModuleInfo` show installed parsers + +## Open issues/TODOs + +- Git handling in general +- Directory browsing with Telescope +- Solution to show short Git logs (potentially without fugitive) +- Hinting for trailing spaces (EOL) and blank space on line diff --git a/init.lua b/init.lua index 50ac784..9f12c13 100644 --- a/init.lua +++ b/init.lua @@ -2,13 +2,10 @@ My simple Neovim configuration. Made from scratch, inspired by https://www.youtube.com/watch?v=w7i4amO_zaE -EXTERNAL DEPENDENCIES: +EXTERNAL DEPENDENCIES - ripgrep (https://github.com/BurntSushi/ripgrep, used by telescope) - fd (https://github.com/sharkdp/fd, used by telescope) -- Nerd font (https://www.nerdfonts.com/, used by nvim-web-devicons) - -CHANGELOG: - - 2023-11-20: init, lazy, fuzzy, remaps +- A Nerd font (https://www.nerdfonts.com/, used by nvim-web-devicons) --]] -- Include customized configuration