aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDamjan 9000 <damjan.9000@gmail.com>2024-03-20 20:40:11 +0100
committerDamjan 9000 <damjan.9000@gmail.com>2024-03-20 20:40:11 +0100
commit2860431c6dd8f3c05dea424380e4f2afd1c2518d (patch)
treee456f0d6b1d56f9f134455d1352fede609c6435c
parent01970d6888847075f39d4a69ec65214baf1ec7f6 (diff)
parent4c02e29e49bf2e3b478f751f9dd78ae4b138232a (diff)
Merge 'upstream' Update README.md (reordering of recommended steps)
-rw-r--r--README.md27
1 files changed, 14 insertions, 13 deletions
diff --git a/README.md b/README.md
index bcf4f25..00f463e 100644
--- a/README.md
+++ b/README.md
@@ -50,7 +50,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-modular.nvim.git`
+
+#### Clone kickstart.nvim
+> **NOTE**
+> If following the recommended step above (i.e., forking the repo), replace `dam9000` with `<your_github_username>` in the commands below
<details><summary> Linux and Mac </summary>
@@ -90,18 +99,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-modular.nvim.git`
#### Examples of adding popularly requested plugins
@@ -161,6 +158,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?