diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 17 |
1 files changed, 11 insertions, 6 deletions
@@ -1,11 +1,13 @@ -# kickstart.nvim +# kickstart-modular.nvim ## Introduction +*This is a fork of [nvim-lua/kickstart.nvim](https://github.com/nvim-lua/kickstart.nvim) that moves from a single file to a multi file configuration.* + A starting point for Neovim that is: * Small -* Single-file +* Modular * Completely Documented **NOT** a Neovim distribution, but instead a starting point for your configuration. @@ -52,7 +54,7 @@ Clone kickstart.nvim: <details><summary> Linux and Mac </summary> ```sh -git clone https://github.com/nvim-lua/kickstart.nvim.git "${XDG_CONFIG_HOME:-$HOME/.config}"/nvim +git clone https://github.com/dam9000/kickstart-modular.nvim.git "${XDG_CONFIG_HOME:-$HOME/.config}"/nvim ``` </details> @@ -62,13 +64,13 @@ git clone https://github.com/nvim-lua/kickstart.nvim.git "${XDG_CONFIG_HOME:-$HO If you're using `cmd.exe`: ``` -git clone https://github.com/nvim-lua/kickstart.nvim.git %userprofile%\AppData\Local\nvim\ +git clone https://github.com/dam9000/kickstart-modular.nvim.git %userprofile%\AppData\Local\nvim\ ``` If you're using `powershell.exe` ``` -git clone https://github.com/nvim-lua/kickstart.nvim.git $env:USERPROFILE\AppData\Local\nvim\ +git clone https://github.com/dam9000/kickstart-modular.nvim.git $env:USERPROFILE\AppData\Local\nvim\ ``` </details> @@ -98,7 +100,7 @@ information about extending and exploring Neovim. can install it on your machine using the methods above. > **NOTE** -> Your fork's url will be something like this: `https://github.com/<your_github_username>/kickstart.nvim.git` +> Your fork's url will be something like this: `https://github.com/<your_github_username>/kickstart-modular.nvim.git` #### Examples of adding popularly requested plugins @@ -179,6 +181,9 @@ return { into smaller parts. A fork of kickstart that does this while maintaining the same functionality is available here: * [kickstart-modular.nvim](https://github.com/dam9000/kickstart-modular.nvim) + * *NOTE: This is the fork that splits the configuration into smaller parts.* + The original repo with the single `init.lua` file is available here: + * [kickstart.nvim](https://github.com/nvim-lua/kickstart.nvim) * Discussions on this topic can be found here: * [Restructure the configuration](https://github.com/nvim-lua/kickstart.nvim/issues/218) * [Reorganize init.lua into a multi-file setup](https://github.com/nvim-lua/kickstart.nvim/pull/473) |