Skip to content

Commit 267fb6a

Browse files
authored
Merge pull request #2068 from stephansama/feature/update-readme-for-templating
chore: updated readme
2 parents 216e06a + 7a3532a commit 267fb6a

1 file changed

Lines changed: 16 additions & 7 deletions

File tree

README.md

Lines changed: 16 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -61,23 +61,32 @@ Neovim's configurations are located under the following paths, depending on your
6161

6262
#### Recommended Step
6363

64-
[Fork](https://docs.github.com/en/get-started/quickstart/fork-a-repo) this repo
65-
so that you have your own copy that you can modify, then install by cloning the
66-
fork to your machine using one of the commands below, depending on your OS.
64+
Create your own copy of this repo using GitHub's
65+
["Use this template"](https://docs.github.com/en/repositories/creating-and-managing-repositories/creating-a-repository-from-a-template)
66+
button so that you have your own copy that you can modify, then install by
67+
cloning your new repo to your machine using one of the commands below,
68+
depending on your OS.
69+
70+
Alternatively, you can [fork](https://docs.github.com/en/get-started/quickstart/fork-a-repo)
71+
this repo if you prefer an easy upstream sync path (e.g., keeping your config
72+
on a separate branch and fast-forwarding `master` from upstream). See the
73+
[discussion in #1740](https://github.com/nvim-lua/kickstart.nvim/issues/1740)
74+
for the tradeoffs between the two approaches.
6775

6876
> [!NOTE]
69-
> Your fork's URL will be something like this:
77+
> Your repo's URL will be something like this:
7078
> `https://github.com/<your_github_username>/kickstart.nvim.git`
7179
72-
You likely want to remove `nvim-pack-lock.json` from your fork's `.gitignore`
80+
You likely want to remove `nvim-pack-lock.json` from your repo's `.gitignore`
7381
file too - it's ignored in the kickstart repo to make maintenance easier, but
7482
it's recommended to track it in version control (see `:help vim.pack-lockfile`).
7583

7684
#### Clone kickstart.nvim
7785

7886
> [!NOTE]
79-
> If following the recommended step above (i.e., forking the repo), replace
80-
> `nvim-lua` with `<your_github_username>` in the commands below
87+
> If following the recommended step above (i.e., creating your own repo from
88+
> the template or fork), replace `nvim-lua` with `<your_github_username>`
89+
> in the commands below
8190
8291
<details><summary> Linux and Mac </summary>
8392

0 commit comments

Comments
 (0)