Skip to content

Commit

Permalink
Update README.md (nvim-lua#781)
Browse files Browse the repository at this point in the history
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.
  • Loading branch information
bozoputer authored Mar 20, 2024
1 parent 773e482 commit 4c02e29
Showing 1 changed file with 14 additions and 13 deletions.
27 changes: 14 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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>

Expand Down Expand Up @@ -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

Expand Down Expand Up @@ -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?
Expand Down

0 comments on commit 4c02e29

Please sign in to comment.