Initial Nvim Config Commit

README.md

@@ -0,0 +1,54 @@
+<link href="style.css" rel="stylesheet"></link>
+
+# README
+
+### Documentation on how my neovim install is configured
+
+- The File Structure of my configuration
+- Where my files are located, their purpose and how they're called
+
+---
+
+#### Files Extensions Found In This Repo
+
+|                                                                                 |        |          |
+| ------------------------------------------------------------------------------- | ------ | -------- |
+| ![image alt file_ext](https://api.iconify.design/skill-icons:vim-dark.svg)      | `.vim` | Vim      |
+| ![image alt file_ext](https://api.iconify.design/skill-icons:lua-dark.svg)      | `.lua` | Lua      |
+| ![image alt file_ext](https://api.iconify.design/skill-icons:markdown-dark.svg) | `.md`  | Markdown |
+
+## CURRENT FILE STRUCTURE
+
+```text
+📁 ~/.config/nvim
+├── 📁 after
+├── 📁 ftplugin
+├── 📁 lua
+│  ├── 📁 other_modules
+│  └── ⚙ init.lua
+├── 📁 plugin
+│  └── ⚙ init-vim-plug.vim
+├── 📁 syntax
+├── 📁 TMP
+├── 📁 vimplug
+├── ⚙ README.md
+└── ⚙ init.vim
+```
+
+## Function Equivalence
+
+|    function     |    .lua     |   .vim   | Vimscript Functions From Lua |
+| :-------------: | :---------: | :------: | :--------------------------: |
+| Sourcing a file | `require()` | `source` |      `vim.cmd.source()`      |
+
+[Vim Commands](https://neovim.io/doc/user/lua-guide.html#lua-guide-vim-commands)
+
+> Use **require()** when trying to source a `.lua` file inside a `.lua`, if you want to source `.vim` files use the lua vim interpretor `vim.cmd.source()`.
+
+[Vimscript Functions](https://neovim.io/doc/user/lua-guide.html#lua-guide-vim-functions)
+
+> If the `vim` function you're trying to call inside of a `.lua` file isn't a Vim command use the Vimscript Functions nomenclature instead.
+
+Use the `See also:`section for more information on which commands can be called
+
+[Function List](https://neovim.io/doc/user/usr_41.html#function-list)