A launch point for your personal nvim configuration
Go to file
km bfd60f3e7b add obsidian 2025-01-04 01:41:10 +00:00
.github Add a pull request template (#825) 2024-04-04 10:31:37 -04:00
doc feat: move to lazy.nvim package manager and add first plugins (#178) 2023-02-17 16:31:57 -05:00
lua add obsidian 2025-01-04 01:41:10 +00:00
.gitignore update README 2024-12-09 13:35:02 +00:00
.stylua.toml Use call_parentheses 2023-06-16 21:12:11 -07:00
LICENSE.md license 2022-06-25 21:51:44 -04:00
README.md update README 2024-12-09 13:35:02 +00:00
init.lua add obsidian 2025-01-04 01:41:10 +00:00
lazy-lock.json add module obsidian 2025-01-04 01:39:32 +00:00

README.md

NVIM

Introduction

My NeoVIM configuration. Intially based on Kickstart.nvim.

Installation

Install Neovim

TODO: Add instructions for installing Neovim.

Install External Dependencies

External Requirements:

  • Basic utils: git, make, unzip, C Compiler (gcc)
  • ripgrep
  • Clipboard tool (xclip/xsel/win32yank or other depending on platform)
  • A Nerd Font: optional, provides various icons
    • if you have it set vim.g.have_nerd_font in init.lua to true
  • Language Setup:
    • npm
  • AI setup
    • copilot
    • codeium
    • chatgpt

Configuration layout

Neovim's configurations are located under the following paths, depending on your OS:

OS PATH
Linux, MacOS $XDG_CONFIG_HOME/nvim, ~/.config/nvim
Windows (cmd) %localappdata%\nvim\
Windows (powershell) $env:LOCALAPPDATA\nvim\

Installation

Linux

git clone https://github.com/llcoolkm/nvim.git "${XDG_CONFIG_HOME:-$HOME/.config}"/nvim

Windows

git clone https://github.com/llcoolkm/nvim.git "%localappdata%\nvim"

or

git clone https://github.com/llcoolkm/nvim.git "${env:LOCALAPPDATA}\nvim"

Getting Started

The Only Video You Need to Get Started with Neovim

Windows Installation

Windows with Microsoft C++ Build Tools and CMake Installation may require installing build tools and updating the run command for `telescope-fzf-native`

See telescope-fzf-native documentation for more details

This requires:

  • Install CMake and the Microsoft C++ Build Tools on Windows
{'nvim-telescope/telescope-fzf-native.nvim', build = 'cmake -S. -Bbuild -DCMAKE_BUILD_TYPE=Release && cmake --build build --config Release && cmake --install build --prefix build' }
Windows with gcc/make using chocolatey Alternatively, one can install gcc and make which don't require changing the config, the easiest way is to use choco:
  1. install chocolatey either follow the instructions on the page or use winget, run in cmd as admin:
winget install --accept-source-agreements chocolatey.chocolatey
  1. install all requirements using choco, exit previous cmd and open a new one so that choco path is set, and run in cmd as admin:
choco install -y neovim git ripgrep wget fd unzip gzip mingw make
WSL (Windows Subsystem for Linux)
wsl --install
wsl
sudo add-apt-repository ppa:neovim-ppa/unstable -y
sudo apt update
sudo apt install make gcc ripgrep unzip git xclip neovim

Linux Install

Ubuntu Install Steps
sudo add-apt-repository ppa:neovim-ppa/unstable -y
sudo apt update
sudo apt install make gcc ripgrep unzip git xclip neovim
Debian Install Steps
sudo apt update
sudo apt install make gcc ripgrep unzip git xclip curl

# Now we install nvim
curl -LO https://github.com/neovim/neovim/releases/download/v0.10.2/nvim-linux64.tar.gz
sudo rm -rf /opt/nvim-linux64
sudo mkdir -p /opt/nvim-linux64
sudo chmod a+rX /opt/nvim-linux64
sudo tar -C /opt -xzf nvim-linux64.tar.gz

# make it available in /usr/local/bin, distro installs to /usr/bin
sudo ln -sf /opt/nvim-linux64/bin/nvim /usr/local/bin/
Fedora Install Steps
sudo dnf install -y gcc make git ripgrep fd-find unzip neovim
Arch Install Steps
sudo pacman -S --noconfirm --needed gcc make git ripgrep fd unzip neovim