From f1de74680aadccd645e178b345a09f83e7863754 Mon Sep 17 00:00:00 2001 From: stephansama Date: Thu, 28 May 2026 04:07:22 -0400 Subject: [PATCH 1/2] chore: updated readme --- README.md | 17 ++++++++++------- 1 file changed, 10 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 7c62e907..f566dba3 100644 --- a/README.md +++ b/README.md @@ -61,23 +61,26 @@ Neovim's configurations are located under the following paths, depending on your #### Recommended Step -[Fork](https://docs.github.com/en/get-started/quickstart/fork-a-repo) this repo -so that you have your own copy that you can modify, then install by cloning the -fork to your machine using one of the commands below, depending on your OS. +Create your own copy of this repo using GitHub's +["Use this template"](https://docs.github.com/en/repositories/creating-and-managing-repositories/creating-a-repository-from-a-template) +button so that you have your own copy that you can modify, then install by +cloning your new repo to your machine using one of the commands below, +depending on your OS. > [!NOTE] -> Your fork's URL will be something like this: +> Your repo's URL will be something like this: > `https://github.com//kickstart.nvim.git` -You likely want to remove `nvim-pack-lock.json` from your fork's `.gitignore` +You likely want to remove `nvim-pack-lock.json` from your repo's `.gitignore` file too - it's ignored in the kickstart repo to make maintenance easier, but it's recommended to track it in version control (see `:help vim.pack-lockfile`). #### Clone kickstart.nvim > [!NOTE] -> If following the recommended step above (i.e., forking the repo), replace -> `nvim-lua` with `` in the commands below +> If following the recommended step above (i.e., creating your own repo from +> the template), replace `nvim-lua` with `` in the +> commands below
Linux and Mac From 7a3532ac07d7054261765854e7d72cb51db4e717 Mon Sep 17 00:00:00 2001 From: stephansama Date: Fri, 12 Jun 2026 09:52:53 -0400 Subject: [PATCH 2/2] chore: add language for forks --- README.md | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index f566dba3..28c01bdb 100644 --- a/README.md +++ b/README.md @@ -67,6 +67,12 @@ button so that you have your own copy that you can modify, then install by cloning your new repo to your machine using one of the commands below, depending on your OS. +Alternatively, you can [fork](https://docs.github.com/en/get-started/quickstart/fork-a-repo) +this repo if you prefer an easy upstream sync path (e.g., keeping your config +on a separate branch and fast-forwarding `master` from upstream). See the +[discussion in #1740](https://github.com/nvim-lua/kickstart.nvim/issues/1740) +for the tradeoffs between the two approaches. + > [!NOTE] > Your repo's URL will be something like this: > `https://github.com//kickstart.nvim.git` @@ -79,8 +85,8 @@ it's recommended to track it in version control (see `:help vim.pack-lockfile`). > [!NOTE] > If following the recommended step above (i.e., creating your own repo from -> the template), replace `nvim-lua` with `` in the -> commands below +> the template or fork), replace `nvim-lua` with `` +> in the commands below
Linux and Mac