diff --git a/README.md b/README.md index 7c62e907..28c01bdb 100644 --- a/README.md +++ b/README.md @@ -61,23 +61,32 @@ 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. + +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 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 or fork), replace `nvim-lua` with `` +> in the commands below
Linux and Mac