Skip to content

Commit

Permalink
Merge remote-tracking branch 'upstream/master'
Browse files Browse the repository at this point in the history
* upstream/master: (72 commits)
  README: wrap long lines (nvim-lua#784)
  Update README.md (nvim-lua#781)
  Add nvim-nio as dependency for nvim-dap-ui (nvim-lua#774)
  Some suggestions and capitalised a few words (nvim-lua#771)
  feat: add linter plugin (nvim-lua#699)
  assign table to filetype in lua_ls config comment (nvim-lua#770)
  README: additional install recipes for various OS (nvim-lua#767)
  conform: disable autoformat on save for specified filetypes (nvim-lua#694)
  Update README.md (nvim-lua#763)
  fix: disable ts indenting for Ruby
  doc: add note about advanced luasnip features
  Move friendly snippets to dependencies of LuaSnip (nvim-lua#759)
  Add <C-b>/<C-f> cmp mapping to scroll cmp docs (nvim-lua#750)
  doc: add info about timeoutlen (nvim-lua#691)
  Revert "Use `cmp-nvim-lua` as `nvim-cmp` source for neovim Lua API (nvim-lua#696)" (nvim-lua#755)
  Use `cmp-nvim-lua` as `nvim-cmp` source for neovim Lua API (nvim-lua#696)
  Added folke/neodev.nvim for proper nvim api completion and annotation (nvim-lua#754)
  chore: rename <C-T> to <C-t> for consistency (nvim-lua#719)
  feat: allow treesitter defaults to be overwritten from custom directory (nvim-lua#732)
  README.md: update neo-tree example - remove legacy setting (nvim-lua#744)
  ...
  • Loading branch information
haroun committed Mar 22, 2024
2 parents b59bc73 + dbba54c commit 76f6dd3
Showing 1 changed file with 36 additions and 18 deletions.
54 changes: 36 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,22 @@ 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 +103,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 All @@ -108,7 +111,9 @@ NOTE: You'll need to uncomment the line in the init.lua that turns on loading cu
<details>
<summary>Adding autopairs</summary>

This will automatically install [windwp/nvim-autopairs](https://github.com/windwp/nvim-autopairs) and enable it on startup. For more information, see documentation for [lazy.nvim](https://github.com/folke/lazy.nvim).
This will automatically install [windwp/nvim-autopairs](https://github.com/windwp/nvim-autopairs)
and enable it on startup. For more information, see documentation for
[lazy.nvim](https://github.com/folke/lazy.nvim).

In the file: `lua/custom/plugins/autopairs.lua`, add:

Expand Down Expand Up @@ -136,7 +141,9 @@ return {
<details>
<summary>Adding a file tree plugin</summary>

This will install the tree plugin and add the command `:Neotree` for you. For more information, see the documentation at [neo-tree.nvim](https://github.com/nvim-neo-tree/neo-tree.nvim).
This will install the tree plugin and add the command `:Neotree` for you.
For more information, see the documentation at
[neo-tree.nvim](https://github.com/nvim-neo-tree/neo-tree.nvim).

In the file: `lua/custom/plugins/filetree.lua`, add:

Expand All @@ -159,17 +166,27 @@ 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?
* You should back it up and then delete all associated files.
* This includes your existing init.lua and the neovim files in `~/.local` which can be deleted with `rm -rf ~/.local/share/nvim/`
* This includes your existing init.lua and the neovim files in `~/.local`
which can be deleted with `rm -rf ~/.local/share/nvim/`
* Can I keep my existing configuration in parallel to kickstart?
* Yes! You can use [NVIM_APPNAME](https://neovim.io/doc/user/starting.html#%24NVIM_APPNAME)`=nvim-NAME` to maintain multiple configurations. For example, you can install the kickstart configuration in `~/.config/nvim-kickstart` and create an alias:
* Yes! You can use [NVIM_APPNAME](https://neovim.io/doc/user/starting.html#%24NVIM_APPNAME)`=nvim-NAME`
to maintain multiple configurations. For example, you can install the kickstart
configuration in `~/.config/nvim-kickstart` and create an alias:
```
alias nvim-kickstart='NVIM_APPNAME="nvim-kickstart" nvim'
```
When you run Neovim using `nvim-kickstart` alias it will use the alternative config directory and the matching local directory `~/.local/share/nvim-kickstart`. You can apply this approach to any Neovim distribution that you would like to try out.
When you run Neovim using `nvim-kickstart` alias it will use the alternative
config directory and the matching local directory
`~/.local/share/nvim-kickstart`. You can apply this approach to any Neovim
distribution that you would like to try out.
* What if I want to "uninstall" this configuration:
* See [lazy.nvim uninstall](https://github.com/folke/lazy.nvim#-uninstalling) information
* Why is the kickstart `init.lua` a single file? Wouldn't it make sense to split it into multiple files?
Expand Down Expand Up @@ -258,3 +275,4 @@ sudo dnf install -y gcc make git ripgrep fd-find neovim
```
</details>


0 comments on commit 76f6dd3

Please sign in to comment.