kickstart.nvim/README.md

2.3 KiB

newbim.nvim

Introduction

This is a fork of https://github.com/nvim-lua/kickstart.nvim

Installation

Install Neovim

Install External Dependencies

External Requirements:

  • Basic utils: git, make, unzip, C Compiler (gcc)
  • ripgrep
  • Clipboard tool (xclip/xsel/win32yank or other depending on the platform)
  • A Nerd Font: optional, provides various icons
    • if you have it set vim.g.have_nerd_font in init.lua to true
  • Emoji fonts (Ubuntu only, and only if you want emoji!) sudo apt install fonts-noto-color-emoji
  • Language Setup:
    • If you want to write Typescript, you need npm
    • If you want to write Golang, you will need go
    • etc.

[!NOTE] See Install Recipes for additional Windows and Linux specific notes and quick install snippets

Install Newbim

[!NOTE] Backup your previous configuration (if any exists)

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\

Fork this repo so that you have your own copy that you can modify, then install by cloning the fork to your machine using one of the commands below, depending on your OS.

You likely want to remove lazy-lock.json from your fork's .gitignore file too - it's ignored in the kickstart repo to make maintenance easier, but it's recommended to track it in version control.

Clone newbim

[!NOTE] If following the recommended step above (i.e., forking the repo), replace fonych1 with <your_github_username> in the commands below

Linux and Mac
git clone git@github.com:fonych1/newbim.git "${XDG_CONFIG_HOME:-$HOME/.config}"/nvim
Windows

If you're using cmd.exe:

git clone git@github.com:fonych1/newbim.git "%localappdata%\nvim"

If you're using powershell.exe

git clone git@github.com:fonych1/newbim.git "${env:LOCALAPPDATA}\nvim"