|
|
|
@@ -22,24 +22,24 @@ If you are experiencing issues, please make sure you have the latest versions.
|
|
|
|
|
### Install External Dependencies
|
|
|
|
|
|
|
|
|
|
External Requirements:
|
|
|
|
|
* Basic utils: `git`, `make`, `unzip`, C Compiler (`gcc`)
|
|
|
|
|
* [ripgrep](https://github.com/BurntSushi/ripgrep#installation)
|
|
|
|
|
* Clipboard tool (xclip/xsel/win32yank or other depending on 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
|
|
|
|
|
* Language Setup:
|
|
|
|
|
* If want to write Typescript, you need `npm`
|
|
|
|
|
* If want to write Golang, you will need `go`
|
|
|
|
|
* etc.
|
|
|
|
|
- Basic utils: `git`, `make`, `unzip`, C Compiler (`gcc`)
|
|
|
|
|
- [ripgrep](https://github.com/BurntSushi/ripgrep#installation)
|
|
|
|
|
- Clipboard tool (xclip/xsel/win32yank or other depending on 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
|
|
|
|
|
- Language Setup:
|
|
|
|
|
- If want to write Typescript, you need `npm`
|
|
|
|
|
- If want to write Golang, you will need `go`
|
|
|
|
|
- etc.
|
|
|
|
|
|
|
|
|
|
> **NOTE**
|
|
|
|
|
> See [Install Recipes](#install-recipes) for additional Windows and Linux specific notes
|
|
|
|
|
> See [Install Recipes](#Install-Recipes) for additional Windows and Linux specific notes
|
|
|
|
|
> and quick install snippets
|
|
|
|
|
|
|
|
|
|
### Install Kickstart
|
|
|
|
|
|
|
|
|
|
> **NOTE**
|
|
|
|
|
> [Backup](#faq) your previous configuration (if any exists)
|
|
|
|
|
> [Backup](#FAQ) your previous configuration (if any exists)
|
|
|
|
|
|
|
|
|
|
Neovim's configurations are located under the following paths, depending on your OS:
|
|
|
|
|
|
|
|
|
@@ -60,7 +60,6 @@ fork to your machine using one of the commands below, depending on your OS.
|
|
|
|
|
> `https://github.com/<your_github_username>/kickstart.nvim.git`
|
|
|
|
|
|
|
|
|
|
#### Clone kickstart.nvim
|
|
|
|
|
>
|
|
|
|
|
> **NOTE**
|
|
|
|
|
> If following the recommended step above (i.e., forking the repo), replace
|
|
|
|
|
> `nvim-lua` with `<your_github_username>` in the commands below
|
|
|
|
@@ -104,6 +103,7 @@ Read through the `init.lua` file in your configuration folder for more
|
|
|
|
|
information about extending and exploring Neovim. That also includes
|
|
|
|
|
examples of adding popularly requested plugins.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
### Getting Started
|
|
|
|
|
|
|
|
|
|
[The Only Video You Need to Get Started with Neovim](https://youtu.be/m8C0Cq9Uv9o)
|
|
|
|
@@ -118,11 +118,9 @@ examples of adding popularly requested plugins.
|
|
|
|
|
* 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
|
|
|
|
@@ -133,7 +131,7 @@ examples of adding popularly requested plugins.
|
|
|
|
|
* 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
|
|
|
|
|
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:
|
|
|
|
@@ -144,7 +142,7 @@ examples of adding popularly requested plugins.
|
|
|
|
|
|
|
|
|
|
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.
|
|
|
|
|
After installing all the dependencies continue with the [Install Kickstart](#Install-Kickstart) step.
|
|
|
|
|
|
|
|
|
|
#### Windows Installation
|
|
|
|
|
|
|
|
|
@@ -155,12 +153,11 @@ See `telescope-fzf-native` documentation for [more details](https://github.com/n
|
|
|
|
|
|
|
|
|
|
This requires:
|
|
|
|
|
|
|
|
|
|
* Install CMake and the Microsoft C++ Build Tools on Windows
|
|
|
|
|
- Install CMake and the Microsoft C++ Build Tools on Windows
|
|
|
|
|
|
|
|
|
|
```lua
|
|
|
|
|
{'nvim-telescope/telescope-fzf-native.nvim', build = 'cmake -S. -Bbuild -DCMAKE_BUILD_TYPE=Release && cmake --build build --config Release && cmake --install build --prefix build' }
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
</details>
|
|
|
|
|
<details><summary>Windows with gcc/make using chocolatey</summary>
|
|
|
|
|
Alternatively, one can install gcc and make which don't require changing the config,
|
|
|
|
@@ -169,18 +166,15 @@ 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 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
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
</details>
|
|
|
|
|
<details><summary>WSL (Windows Subsystem for Linux)</summary>
|
|
|
|
|
|
|
|
|
@@ -191,11 +185,9 @@ sudo add-apt-repository ppa:neovim-ppa/unstable -y
|
|
|
|
|
sudo apt update
|
|
|
|
|
sudo apt install make gcc ripgrep unzip git xclip neovim
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
</details>
|
|
|
|
|
|
|
|
|
|
#### Linux Install
|
|
|
|
|
|
|
|
|
|
<details><summary>Ubuntu Install Steps</summary>
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
@@ -203,7 +195,6 @@ sudo add-apt-repository ppa:neovim-ppa/unstable -y
|
|
|
|
|
sudo apt update
|
|
|
|
|
sudo apt install make gcc ripgrep unzip git xclip neovim
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
</details>
|
|
|
|
|
<details><summary>Debian Install Steps</summary>
|
|
|
|
|
|
|
|
|
@@ -221,14 +212,12 @@ 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/
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
</details>
|
|
|
|
|
<details><summary>Fedora Install Steps</summary>
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
sudo dnf install -y gcc make git ripgrep fd-find unzip neovim
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
</details>
|
|
|
|
|
|
|
|
|
|
<details><summary>Arch Install Steps</summary>
|
|
|
|
@@ -236,5 +225,5 @@ sudo dnf install -y gcc make git ripgrep fd-find unzip neovim
|
|
|
|
|
```
|
|
|
|
|
sudo pacman -S --noconfirm --needed gcc make git ripgrep fd unzip neovim
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
</details>
|
|
|
|
|
|
|
|
|
|
Alex Muszynski