summaryrefslogtreecommitdiffstats
path: root/nvim
diff options
context:
space:
mode:
authorPeter S. Jaglom <145091604+pjaglom@users.noreply.github.com>2023-12-22 00:31:59 -0800
committerGitHub <noreply@github.com>2023-12-22 09:31:59 +0100
commitf87ebfb9724022d01ff7c7f120894d22c6690d1e (patch)
tree252af42ff6b1f2bebbe5c89fef03c704c35b8c12 /nvim
parentf94eba2a41b616d7bed0e0a4aa6f1b4d2aefcf81 (diff)
downloaddots-f87ebfb9724022d01ff7c7f120894d22c6690d1e.tar.gz
Minor changes to README to reflect the modular repo (#3)
* Update README to reflect modular organization - Change install links to this repo instead of nvim-lua/kickstart.nvim - Change “Recommended Steps” repo link to reflect kickstart-modular.nvim.git - Change FAQ re: multiple files to reflect that we are in the modular repo, not the single file repo.
Diffstat (limited to 'nvim')
-rw-r--r--nvim/README.md15
1 files changed, 8 insertions, 7 deletions
diff --git a/nvim/README.md b/nvim/README.md
index 839a5cf..21b7a90 100644
--- a/nvim/README.md
+++ b/nvim/README.md
@@ -42,17 +42,17 @@ Clone kickstart.nvim:
- on Linux and Mac
```sh
-git clone https://github.com/nvim-lua/kickstart.nvim.git "${XDG_CONFIG_HOME:-$HOME/.config}"/nvim
+git clone https://github.com/dam9000/kickstart-modular.nvim.git "${XDG_CONFIG_HOME:-$HOME/.config}"/nvim
```
- on Windows (cmd)
```
-git clone https://github.com/nvim-lua/kickstart.nvim.git %userprofile%\AppData\Local\nvim\
+git clone https://github.com/dam9000/kickstart-modular.nvim.git %userprofile%\AppData\Local\nvim\
```
- on Windows (powershell)
```
-git clone https://github.com/nvim-lua/kickstart.nvim.git $env:USERPROFILE\AppData\Local\nvim\
+git clone https://github.com/dam9000/kickstart-modular.nvim.git $env:USERPROFILE\AppData\Local\nvim\
```
@@ -77,7 +77,7 @@ nvim --headless "+Lazy! sync" +qa
[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 installing you can install to 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`
+> Your fork's url will be something like this: `https://github.com/<your_github_username>/kickstart-modular.nvim.git`
### Configuration And Extension
@@ -171,9 +171,10 @@ Each PR, especially those which increase the line count, should have a descripti
* The main purpose of kickstart is to serve as a teaching tool and a reference
configuration that someone can easily `git clone` as a basis for their own.
As you progress in learning Neovim and Lua, you might consider splitting `init.lua`
- into smaller parts. A fork of kickstart that does this while maintaining the exact
- same functionality is available here:
- * [kickstart-modular.nvim](https://github.com/dam9000/kickstart-modular.nvim)
+ into smaller parts. *This is the fork of the original project that splits the configuration into smaller parts.*
+ The original repo that maintains the exact
+ same functionality in a single `init.lua` file is available here:
+ * [kickstart.nvim](https://github.com/dam9000/kickstart-modular.nvim)
* Discussions on this topic can be found here:
* [Restructure the configuration](https://github.com/nvim-lua/kickstart.nvim/issues/218)
* [Reorganize init.lua into a multi-file setup](https://github.com/nvim-lua/kickstart.nvim/pull/473)