108 lines
2.8 KiB
Markdown
108 lines
2.8 KiB
Markdown
# javif89 Neovim Config
|
|
|
|
Based on [Kickstart](https://github.com/nvim-lua/kickstart.nvim). Some of the install
|
|
instructions come from kickstart so I don't forget about any dependencies.
|
|
|
|
## Structure
|
|
|
|
I try to keep the config modular not because I want to change it all the time, but because
|
|
I want it to be easy to look through and understand.
|
|
|
|
The files are organized as such inside the `lua` folder:
|
|
|
|
`core/`: Any component of the config that I absolutely must have in any system for the rest of time.
|
|
|
|
`core/plugins`: Necessarry plugins such as mason, tree sitter and such.
|
|
|
|
`optional`: Anything that I could remove and live without.
|
|
|
|
## Installation
|
|
|
|
### 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
|
|
|
|
> **NOTE**
|
|
> See [Install Recipes](#Install-Recipes) for additional Windows and Linux specific notes
|
|
> and quick install snippets
|
|
|
|
### Install Config
|
|
|
|
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\` |
|
|
|
|
**Linux and Mac**
|
|
|
|
```sh
|
|
git clone https://github.com/javif89/nvim.git "${XDG_CONFIG_HOME:-$HOME/.config}"/nvim
|
|
```
|
|
|
|
**Windows**
|
|
|
|
```
|
|
git clone https://github.com/javif89/nvim.git "${env:LOCALAPPDATA}\nvim"
|
|
```
|
|
|
|
|
|
### Getting Started
|
|
|
|
[The Only Video You Need to Get Started with Neovim](https://youtu.be/m8C0Cq9Uv9o)
|
|
|
|
### Install Recipes
|
|
|
|
#### Windows Installation
|
|
|
|
```
|
|
choco install -y neovim git ripgrep wget fd unzip gzip mingw make
|
|
```
|
|
|
|
#### 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 unzip git xclip neovim
|
|
```
|
|
</details>
|
|
<details><summary>Debian Install Steps</summary>
|
|
|
|
```
|
|
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/latest/download/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/
|
|
```
|
|
</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>
|
|
|
|
```
|
|
sudo pacman -S --noconfirm --needed gcc make git ripgrep fd unzip neovim
|
|
```
|
|
</details>
|