183 lines
6.9 KiB
Markdown
183 lines
6.9 KiB
Markdown
# kickstart.nvim
|
|
|
|
Personal fork of kickstart.nvim
|
|
|
|
[Link to kickstart repo](https://github.com/nvim-lua/kickstart.nvim)
|
|
|
|
|
|
## Installation
|
|
|
|
### Install Neovim
|
|
|
|
Kickstart.nvim targets *only* the latest
|
|
['stable'](https://github.com/neovim/neovim/releases/tag/stable) and latest
|
|
['nightly'](https://github.com/neovim/neovim/releases/tag/nightly) of Neovim.
|
|
If you are experiencing issues, please make sure you have at least the latest
|
|
stable version. Most likely, you want to install neovim via a [package
|
|
manager](https://github.com/neovim/neovim/blob/master/INSTALL.md#install-from-package).
|
|
To check your neovim version, run `nvim --version` and make sure it is not
|
|
below the latest
|
|
['stable'](https://github.com/neovim/neovim/releases/tag/stable) version. If
|
|
your chosen install method only gives you an outdated version of neovim, find
|
|
alternative [installation methods below](#alternative-neovim-installation-methods).
|
|
|
|
### Install External Dependencies
|
|
|
|
- Basic utils: `git`, `make`, `unzip`, C Compiler (`gcc`)
|
|
- [ripgrep](https://github.com/BurntSushi/ripgrep#installation),
|
|
[fd-find](https://github.com/sharkdp/fd#installation)
|
|
- [tree-sitter CLI](https://github.com/tree-sitter/tree-sitter/blob/master/crates/cli/README.md#installation)
|
|
- Clipboard tool (xclip/xsel/win32yank or other depending on the platform)
|
|
- A [Nerd Font](https://www.nerdfonts.com/): 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`
|
|
|
|
### Install Kickstart
|
|
|
|
After cloning, move files into ~/.config/nvim/
|
|
|
|
### Getting Started
|
|
|
|
[The Only Video You Need to Get Started with Neovim](https://youtu.be/m8C0Cq9Uv9o)
|
|
|
|
### FAQ
|
|
|
|
* What should I do if I already have a pre-existing Neovim configuration?
|
|
* You should back it up and then delete all associated files.
|
|
* This includes your existing init.lua and the Neovim files in `~/.local`
|
|
which can be deleted with `rm -rf ~/.local/share/nvim/`
|
|
* Can I keep my existing configuration in parallel to kickstart?
|
|
* Yes! You can use [NVIM_APPNAME](https://neovim.io/doc/user/starting.html#%24NVIM_APPNAME)`=nvim-NAME`
|
|
to maintain multiple configurations. For example, you can install the kickstart
|
|
configuration in `~/.config/nvim-kickstart` and create an alias:
|
|
```
|
|
alias nvim-kickstart='NVIM_APPNAME="nvim-kickstart" nvim'
|
|
```
|
|
When you run Neovim using `nvim-kickstart` alias it will use the alternative
|
|
config directory and the matching local directory
|
|
`~/.local/share/nvim-kickstart`. You can apply this approach to any Neovim
|
|
distribution that you would like to try out.
|
|
* What if I want to "uninstall" this configuration:
|
|
* Remove your config directory and local data directory (for example,
|
|
`~/.config/nvim` and `~/.local/share/nvim`).
|
|
* Why is the kickstart `init.lua` a single file? Wouldn't it make sense to split it into multiple files?
|
|
* The main purpose of kickstart is to serve as a teaching tool and a reference
|
|
configuration that someone can easily use to `git clone` as a basis for their own.
|
|
As you progress in learning Neovim and Lua, you might consider splitting `init.lua`
|
|
into smaller parts. A fork of kickstart that does this while maintaining the
|
|
same functionality is available here:
|
|
* [kickstart-modular.nvim](https://github.com/dam9000/kickstart-modular.nvim)
|
|
* Discussions on this topic can be found here:
|
|
* [Restructure the configuration](https://github.com/nvim-lua/kickstart.nvim/issues/218)
|
|
* [Reorganize init.lua into a multi-file setup](https://github.com/nvim-lua/kickstart.nvim/pull/473)
|
|
|
|
### Install Recipes
|
|
|
|
Below you can find OS specific install instructions for Neovim and dependencies.
|
|
|
|
After installing all the dependencies continue with the [Install Kickstart](#install-kickstart) step.
|
|
|
|
#### Windows Installation
|
|
|
|
<details><summary>Windows with Microsoft C++ Build Tools and CMake</summary>
|
|
Kickstart's default config is make-only for `telescope-fzf-native.nvim`.
|
|
If `make` is unavailable, the plugin is skipped.
|
|
|
|
Recommended: install `make` (see the chocolatey section below).
|
|
|
|
If you want a CMake-only setup, customize `init.lua` in two places:
|
|
|
|
1. Include `telescope-fzf-native.nvim` when `cmake` is available:
|
|
|
|
```lua
|
|
if vim.fn.executable 'make' == 1 or vim.fn.executable 'cmake' == 1 then
|
|
table.insert(plugins, gh 'nvim-telescope/telescope-fzf-native.nvim')
|
|
end
|
|
```
|
|
|
|
2. In the `PackChanged` hook, use CMake when `make` is unavailable:
|
|
|
|
```lua
|
|
if name == 'telescope-fzf-native.nvim' then
|
|
if vim.fn.executable 'make' == 1 then
|
|
run_build(name, { 'make' }, ev.data.path)
|
|
elseif vim.fn.executable 'cmake' == 1 then
|
|
run_build(name, { 'cmake', '-S.', '-Bbuild', '-DCMAKE_BUILD_TYPE=Release' }, ev.data.path)
|
|
run_build(name, { 'cmake', '--build', 'build', '--config', 'Release', '--target', 'install' }, ev.data.path)
|
|
end
|
|
return
|
|
end
|
|
```
|
|
|
|
See `telescope-fzf-native` documentation for [build details](https://github.com/nvim-telescope/telescope-fzf-native.nvim#installation).
|
|
</details>
|
|
<details><summary>Windows with gcc/make using chocolatey</summary>
|
|
Alternatively, one can install gcc and make which don't require changing the config,
|
|
the easiest way is to use choco:
|
|
|
|
1. install [chocolatey](https://chocolatey.org/install)
|
|
either follow the instructions on the page or use winget,
|
|
run in cmd as **admin**:
|
|
```
|
|
winget install --accept-source-agreements chocolatey.chocolatey
|
|
```
|
|
|
|
2. install all requirements using choco, exit the 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 tree-sitter
|
|
```
|
|
</details>
|
|
<details><summary>WSL (Windows Subsystem for Linux)</summary>
|
|
|
|
```
|
|
wsl --install
|
|
wsl
|
|
sudo add-apt-repository ppa:neovim-ppa/unstable -y
|
|
sudo apt update
|
|
sudo apt install make gcc ripgrep fd-find tree-sitter-cli unzip git xclip neovim
|
|
```
|
|
</details>
|
|
|
|
#### Linux Install
|
|
<details><summary>Ubuntu Install Steps</summary>
|
|
|
|
```
|
|
sudo add-apt-repository ppa:neovim-ppa/unstable -y
|
|
sudo apt update
|
|
sudo apt install make gcc ripgrep fd-find tree-sitter-cli unzip git xclip neovim
|
|
```
|
|
</details>
|
|
<details><summary>Debian Install Steps</summary>
|
|
|
|
```
|
|
sudo apt update
|
|
sudo apt install make gcc ripgrep fd-find tree-sitter-cli unzip git xclip curl
|
|
|
|
# Now we install nvim
|
|
curl -LO https://github.com/neovim/neovim/releases/latest/download/nvim-linux-x86_64.tar.gz
|
|
sudo rm -rf /opt/nvim-linux-x86_64
|
|
sudo mkdir -p /opt/nvim-linux-x86_64
|
|
sudo chmod a+rX /opt/nvim-linux-x86_64
|
|
sudo tar -C /opt -xzf nvim-linux-x86_64.tar.gz
|
|
|
|
# make it available in /usr/local/bin, distro installs to /usr/bin
|
|
sudo ln -sf /opt/nvim-linux-x86_64/bin/nvim /usr/local/bin/
|
|
```
|
|
</details>
|
|
<details><summary>Fedora Install Steps</summary>
|
|
|
|
```
|
|
sudo dnf install -y gcc make git ripgrep fd-find tree-sitter-cli unzip neovim
|
|
```
|
|
</details>
|
|
|
|
<details><summary>Arch Install Steps</summary>
|
|
|
|
```
|
|
sudo pacman -S --noconfirm --needed gcc make git ripgrep fd tree-sitter-cli unzip neovim
|
|
```
|
|
</details>
|
|
|
|
test
|