#+#+TITLE:   my nvim config readme
#+AUTHOR:    Asara <amarpreet@minhas.io>
#+DATE:      2023-07-28
* Prerequisites
Installation of this requires compiling/downloading neovim v0.8.3+. Currently tested on v0.9.1

A bootstrap script exists [[https://github.com/Asara/dotfiles/blob/master/scripts/configure_nvim.sh][here]] to quickly set up fonts and download the configuration to the appropriate location.  The script requires sudo so please verify its contents before running it.
* Relevant Files
Files with links are customized

├── [[https://git.minhas.io/Asara/nvim/src/branch/main/init.lua][init.lua]]\\
├── lua\\
│   ├── config\\
│   │   ├── [[https://git.minhas.io/Asara/nvim/src/branch/main/lua/config/autocmds.lua][autocmds.lua]]\\
│   │   ├── [[https://git.minhas.io/Asara/nvim/src/branch/main/lua/config/keymaps.lua][keymaps.lua]]\\
│   │   ├── lazy.lua\\
│   │   └── [[https://git.minhas.io/Asara/nvim/src/branch/main/lua/config/options.lua][options.lua]]\\
│   └── plugins\\
│       ├── [[https://git.minhas.io/Asara/nvim/src/branch/main/lua/plugins/alpha.lua][alpha.lua]]\\
│       ├── [[https://git.minhas.io/Asara/nvim/src/branch/main/lua/plugins/core.lua][core.lua]]\\
│       └── [[https://git.minhas.io/Asara/nvim/src/branch/main/lua/plugins/theme.lua][theme.lua]]\\
└── [[https://git.minhas.io/Asara/nvim/src/branch/main/stylua.toml][stylua.toml]]
* File Details
[[https://git.minhas.io/Asara/nvim/src/branch/main/init.lua][init.lua]]: initalize lazyvim and orgmode\\
[[https://git.minhas.io/Asara/nvim/src/branch/main/lua/config/autocmds.lua][autocmds.lua]]: configure goyo for writing mode\\
[[https://git.minhas.io/Asara/nvim/src/branch/main/lua/config/keymaps.lua][keymaps.lua]]: lazy escape\\
[[https://git.minhas.io/Asara/nvim/src/branch/main/lua/config/options.lua][options.lua]]: basic vim options\\
[[https://git.minhas.io/Asara/nvim/src/branch/main/lua/plugins/alpha.lua][alpha.lua]]: alpha homescreen modifications\\
[[https://git.minhas.io/Asara/nvim/src/branch/main/lua/plugins/core.lua][core.lua]]: load in plugins\\
[[https://git.minhas.io/Asara/nvim/src/branch/main/lua/plugins/theme.lua][theme.lua]]: theme setup\\
[[https://git.minhas.io/Asara/nvim/src/branch/main/stylua.toml][stylua.toml]]: basic styling