From acbf6a126cde738710d725499ee59af4a558601f Mon Sep 17 00:00:00 2001 From: Chewing_Bever Date: Mon, 1 Feb 2021 09:59:11 +0100 Subject: [PATCH] Started main README --- README.md | 22 +++++++++++++++++++++- init/plugins/README.md | 1 + init/{ => plugins}/plugins.vim | 0 3 files changed, 22 insertions(+), 1 deletion(-) create mode 100644 init/plugins/README.md rename init/{ => plugins}/plugins.vim (100%) diff --git a/README.md b/README.md index c59c716..27d4d3d 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,23 @@ # neovim-config -My full Neovim setup. +This repo contains the full Neovim config that I use on a daily basis for +college and personal projects. + +## Config structure +The config exists of a few key components: + +* `coc-settings.json`: config for the +* `init.vim`: this is the actual config file that gets loaded. It sources + everything else. + [CoC](https://github.com/neoclide/coc.nvim) plugin. +* `autoload/`: a special directory allowing the files inside to be used in the + `:call` command. Its only use is allowing usage of + [vim-plug](https://github.com/junegunn/vim-plug), my plugin manager. +* `colors/`: contains my themes. +* `ftplugin/`: this is where you can put filetype plugins. These are vim + scripts that are sourced whenever you open a buffer with the given filetype, + e.g. if you open a file with filetype `markdown`, it will source the file + `ftplugin/markdown.vim`, if it exists. This allows for custom configs for + certain filetypes. +* `init/`: contains the various config files sourced by `init.vim`. I could + just cram it all into a single file, but I find this difficult to maintain. diff --git a/init/plugins/README.md b/init/plugins/README.md new file mode 100644 index 0000000..ee76a3d --- /dev/null +++ b/init/plugins/README.md @@ -0,0 +1 @@ +# Plugins Used diff --git a/init/plugins.vim b/init/plugins/plugins.vim similarity index 100% rename from init/plugins.vim rename to init/plugins/plugins.vim