From 106ff63106eac667f13d297695c85452bdadc950 Mon Sep 17 00:00:00 2001
From: pika <alex@team-pieck.de>
Date: Mon, 19 Aug 2024 00:18:38 +0200
Subject: [PATCH] readme things

---
 README.md | 23 +++++++++++++++++++++++
 1 file changed, 23 insertions(+)

diff --git a/README.md b/README.md
index 4da7979..0e5bd13 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,25 @@
 # nvim
 
+This is my current neovim configuration. It uses [lazy.nvim]() as the packagemanager.
+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, inside a require{} table.
+> [!TIP]
+> pika is my username, so feel free to change this to your needs.
+
+## installation
+For installation, just git clone this repo to your $HOME/.config/ folder.
+```bash
+git clone --depth=1 https://git.k4li.de/dotfiles/nvim.git $HOME/.config/nvim/
+```
+> [!CAUTION]
+> You're neovim version has to be >=0.9.0
+> If you're not sure what version you have, type `nvim --version`
+> To install neovim 0.9.0 or higher, you can run the following.
+```bash
+bash -c "$(curl -sSL https://git.k4li.de/pika/scripts/raw/branch/main/bash/installs/neovim.sh)"
+```
+
+## configuration
+
+Colorscheme-plugins are defined in [colorschemes.lua](lua/pika/plugins/colorschemes.lua)
+> default theme is [nordic](https://github.com/AlexvZyl/nordic.nvim)
+> you can change the theme in the colorscheme function in the [init.lua](./init.lua)