Baipyrus/nvim-config
1
0
Fork 0
mirror of https://github.com/Baipyrus/nvim-config.git synced 2024-12-25 21:01:45 +00:00
Code Issues Packages Projects Releases Wiki Activity

Minor changes to README to reflect the modular repo (#3)

Browse Source 
* 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.
This commit is contained in:
Peter S. Jaglom 2023-12-22 00:31:59 -08:00 committed by GitHub
parent bc75e6af95
commit f6f5537a3a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 8 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
README.md
View File

@ -42,17 +42,17 @@ Clone kickstart.nvim:
- on Linux and Mac - on Linux and Mac
```sh ```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) - 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) - 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. [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** > **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 ### 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 * 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. 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` 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 into smaller parts. *This is the fork of the original project that splits the configuration into smaller parts.*
same functionality is available here: The original repo that maintains the exact
* [kickstart-modular.nvim](https://github.com/dam9000/kickstart-modular.nvim) 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: * Discussions on this topic can be found here:
* [Restructure the configuration](https://github.com/nvim-lua/kickstart.nvim/issues/218) * [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) * [Reorganize init.lua into a multi-file setup](https://github.com/nvim-lua/kickstart.nvim/pull/473)