nvim/README.md
2025-05-17 11:37:48 +02:00

57 lines
1.9 KiB
Markdown

This is my current neovim configuration. It uses [lazy.nvim](https://github.com/folke/lazy.nvim) as the packagemanager.
> [!TIP]
> pika is my username, so feel free to change this to your needs.
## installation
> [!CAUTION]
> You're neovim version has to be >=0.10.0 </br>
> If you're not sure what version you have, type `nvim --version` </br>
> To build neovim from source, you can run the following. </br>
> This script should cover [most linux distros](https://git.k4li.de/scripts/imports/raw/branch/main/distros.sh "This script is used to detect the linux distros for installing the dependencies and building from source")
>
> ```bash
> curl -fsSL https://git.k4li.de/scripts/installs/raw/branch/main/neovim.sh | bash
> ```
> [!TIP]
> You can run the script silently, via..
>
> ```bash
> curl -fsSL https://... | bash -s -- [ --silent | -s ]
> ```
---
For config-installation, just git clone this repo to your $HOME/.config/ folder.
```bash
git clone --recursive --depth=1 https://git.k4li.de/dotfiles/nvim.git $HOME/.config/nvim/
```
> The `--recursive` flag is for pulling down the snippets submodule, since this is used in more neovim configs </br>
> Prefetch the config with `nvim --headless +q` and enjoy the config
---
## configuration
- Colorscheme-plugins are defined in [colorschemes.lua](lua/pika/plugins/colorschemes.lua)
> [!TIP]
> default theme is `duskfox` </br>
> you can change the theme in the colorscheme function in the [init.lua](./init.lua)
---
- Plugin configuration and adding your own
My config is relatively simple structured. If you want to add a plugin, just create a `<plugin.name>.lua` file in the `lua/pika/plugin/` path which has the plugin code inside a `require{}` table.
```plugin.lua
require{
"<username>/<plugin>", -- <- usually the git username/repo, can also be a full link to external git repo
opts = {}, -- <- put in your plugin configuration content. The opts = {}, calls `require("<plugin>").setup({})`
}
```