From 534966f5e2495e24407b49f05e31ca9b457fbfc9 Mon Sep 17 00:00:00 2001 From: Damjan 9000 Date: Mon, 26 Feb 2024 21:37:26 +0100 Subject: README.md: minor update to the modular fork note --- nvim/README.md | 17 +++++++++++------ 1 file changed, 11 insertions(+), 6 deletions(-) (limited to 'nvim') diff --git a/nvim/README.md b/nvim/README.md index c9b9d84..448a996 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. @@ -48,7 +50,7 @@ Clone kickstart.nvim:
Linux and Mac ```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 ```
@@ -58,13 +60,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\ ``` @@ -96,7 +98,7 @@ install instructions in this file instead. An updated video is coming soon. can install to your machine using the methods above. > **NOTE** -> Your fork's url will be something like this: `https://github.com//kickstart.nvim.git` +> Your fork's url will be something like this: `https://github.com//kickstart-modular.nvim.git` #### Examples of adding popularly requested plugins @@ -175,6 +177,9 @@ return { into smaller parts. A fork of kickstart that does this while maintaining the exact 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) -- cgit v1.2.3