aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorE <2061889+bozoputer@users.noreply.github.com>2024-03-20 14:27:18 -0400
committerGitHub <noreply@github.com>2024-03-20 14:27:18 -0400
commit4c02e29e49bf2e3b478f751f9dd78ae4b138232a (patch)
treee69b536ab6948d31d643e1d67ad9192ec7c865ba
parent773e482d4b40cec4095e4b60fbd753cb69b3f51b (diff)
Update README.md (#781)
The recommended step of forking the repo coming sequentially after the step instructing users to clone the current repo doesn't make sense. This commit orders the install instructions in a manner that's more logical.
-rw-r--r--README.md27
1 files changed, 14 insertions, 13 deletions
diff --git a/README.md b/README.md
index e9d3170..82ca52c 100644
--- a/README.md
+++ b/README.md
@@ -48,7 +48,16 @@ Neovim's configurations are located under the following paths, depending on your
### Install Kickstart
-Clone kickstart.nvim:
+#### 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.
+
+> **NOTE**
+> Your fork's url will be something like this: `https://github.com/<your_github_username>/kickstart.nvim.git`
+
+#### Clone kickstart.nvim
+> **NOTE**
+> If following the recommended step above (i.e., forking the repo), replace `nvim-lua` with `<your_github_username>` in the commands below
<details><summary> Linux and Mac </summary>
@@ -88,18 +97,6 @@ current plugin status.
Read through the `init.lua` file in your configuration folder for more
information about extending and exploring Neovim.
-### Getting Started
-
-[The Only Video You Need to Get Started with Neovim](https://youtu.be/m8C0Cq9Uv9o)
-
-### Recommended Steps
-
-[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) and then install. You
-can install it on your machine using the methods above.
-
-> **NOTE**
-> Your fork's url will be something like this: `https://github.com/<your_github_username>/kickstart.nvim.git`
#### Examples of adding popularly requested plugins
@@ -159,6 +156,10 @@ return {
</details>
+### Getting Started
+
+[The Only Video You Need to Get Started with Neovim](https://youtu.be/m8C0Cq9Uv9o)
+
### FAQ
* What should I do if I already have a pre-existing neovim configuration?