diff options
Diffstat (limited to 'nvim/README.md')
| -rw-r--r-- | nvim/README.md | 19 |
1 files changed, 12 insertions, 7 deletions
diff --git a/nvim/README.md b/nvim/README.md index 4113950..d18e70c 100644 --- a/nvim/README.md +++ b/nvim/README.md @@ -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. @@ -59,7 +61,7 @@ fork to your machine using one of the commands below, depending on your OS. > [!NOTE] > Your fork's URL will be something like this: -> `https://github.com/<your_github_username>/kickstart.nvim.git` +> `https://github.com/<your_github_username>/kickstart-modular.nvim.git` You likely want to remove `lazy-lock.json` from your fork's `.gitignore` file too - it's ignored in the kickstart repo to make maintenance easier, but it's @@ -69,12 +71,12 @@ too - it's ignored in the kickstart repo to make maintenance easier, but it's > [!NOTE] > If following the recommended step above (i.e., forking the repo), replace -> `nvim-lua` with `<your_github_username>` in the commands below +> `dam9000` with `<your_github_username>` in the commands below <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> @@ -84,13 +86,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 "%localappdata%\nvim" +git clone https://github.com/dam9000/kickstart-modular.nvim.git "%localappdata%\nvim" ``` If you're using `powershell.exe` ``` -git clone https://github.com/nvim-lua/kickstart.nvim.git "${env:LOCALAPPDATA}\nvim" +git clone https://github.com/dam9000/kickstart-modular.nvim.git "${env:LOCALAPPDATA}\nvim" ``` </details> @@ -146,6 +148,9 @@ examples of adding popularly requested plugins. 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) |