Skip to content

Commit 7ade9b8

Browse files
authored
Merge branch 'master' into main
2 parents 1d45ed4 + 3338d39 commit 7ade9b8

File tree

8 files changed

+266
-211
lines changed

8 files changed

+266
-211
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,13 @@ assignees: ''
99

1010
<!-- Any bug report not following this template will be immediately closed. Thanks -->
1111

12+
## Before Reporting an Issue
13+
- I have read the kickstart.nvim README.md.
14+
- I have read the appropriate plugin's documentation.
15+
- I have searched that this issue has not been reported before.
16+
17+
- [ ] **By checking this, I confirm that the above steps are completed. I understand leaving this unchecked will result in this report being closed immediately.**
18+
1219
## Describe the bug
1320
<!-- A clear and concise description of what the bug is. -->
1421

@@ -18,8 +25,8 @@ assignees: ''
1825

1926
## Desktop
2027
<!-- please complete the following information. -->
21-
- OS:
22-
- Terminal:
28+
- OS:
29+
- Terminal:
2330

2431
## Neovim Version
2532
<!-- Output of running `:version` from inside of neovim. -->

README.md

Lines changed: 27 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -23,22 +23,24 @@ If you are experiencing issues, please make sure you have the latest versions.
2323

2424
External Requirements:
2525
- Basic utils: `git`, `make`, `unzip`, C Compiler (`gcc`)
26-
- [ripgrep](https://github.com/BurntSushi/ripgrep#installation)
27-
- Clipboard tool (xclip/xsel/win32yank or other depending on platform)
26+
- [ripgrep](https://github.com/BurntSushi/ripgrep#installation),
27+
[fd-find](https://github.com/sharkdp/fd#installation)
28+
- Clipboard tool (xclip/xsel/win32yank or other depending on the platform)
2829
- A [Nerd Font](https://www.nerdfonts.com/): optional, provides various icons
2930
- if you have it set `vim.g.have_nerd_font` in `init.lua` to true
31+
- Emoji fonts (Ubuntu only, and only if you want emoji!) `sudo apt install fonts-noto-color-emoji`
3032
- Language Setup:
3133
- If you want to write Typescript, you need `npm`
3234
- If you want to write Golang, you will need `go`
3335
- etc.
3436

35-
> **NOTE**
37+
> [!NOTE]
3638
> See [Install Recipes](#Install-Recipes) for additional Windows and Linux specific notes
3739
> and quick install snippets
3840
3941
### Install Kickstart
4042

41-
> **NOTE**
43+
> [!NOTE]
4244
> [Backup](#FAQ) your previous configuration (if any exists)
4345
4446
Neovim's configurations are located under the following paths, depending on your OS:
@@ -55,16 +57,17 @@ Neovim's configurations are located under the following paths, depending on your
5557
so that you have your own copy that you can modify, then install by cloning the
5658
fork to your machine using one of the commands below, depending on your OS.
5759

58-
> **NOTE**
59-
> Your fork's url will be something like this:
60+
> [!NOTE]
61+
> Your fork's URL will be something like this:
6062
> `https://github.com/<your_github_username>/kickstart.nvim.git`
6163
6264
You likely want to remove `lazy-lock.json` from your fork's `.gitignore` file
6365
too - it's ignored in the kickstart repo to make maintenance easier, but it's
64-
[recommmended to track it in version control](https://lazy.folke.io/usage/lockfile).
66+
[recommended to track it in version control](https://lazy.folke.io/usage/lockfile).
6567

6668
#### Clone kickstart.nvim
67-
> **NOTE**
69+
70+
> [!NOTE]
6871
> If following the recommended step above (i.e., forking the repo), replace
6972
> `nvim-lua` with `<your_github_username>` in the commands below
7073
@@ -101,22 +104,27 @@ nvim
101104
```
102105

103106
That's it! Lazy will install all the plugins you have. Use `:Lazy` to view
104-
current plugin status. Hit `q` to close the window.
107+
the current plugin status. Hit `q` to close the window.
108+
109+
#### Read The Friendly Documentation
105110

106111
Read through the `init.lua` file in your configuration folder for more
107112
information about extending and exploring Neovim. That also includes
108113
examples of adding popularly requested plugins.
109114

115+
> [!NOTE]
116+
> For more information about a particular plugin check its repository's documentation.
117+
110118

111119
### Getting Started
112120

113121
[The Only Video You Need to Get Started with Neovim](https://youtu.be/m8C0Cq9Uv9o)
114122

115123
### FAQ
116124

117-
* What should I do if I already have a pre-existing neovim configuration?
125+
* What should I do if I already have a pre-existing Neovim configuration?
118126
* You should back it up and then delete all associated files.
119-
* This includes your existing init.lua and the neovim files in `~/.local`
127+
* This includes your existing init.lua and the Neovim files in `~/.local`
120128
which can be deleted with `rm -rf ~/.local/share/nvim/`
121129
* Can I keep my existing configuration in parallel to kickstart?
122130
* Yes! You can use [NVIM_APPNAME](https://neovim.io/doc/user/starting.html#%24NVIM_APPNAME)`=nvim-NAME`
@@ -135,7 +143,7 @@ examples of adding popularly requested plugins.
135143
* The main purpose of kickstart is to serve as a teaching tool and a reference
136144
configuration that someone can easily use to `git clone` as a basis for their own.
137145
As you progress in learning Neovim and Lua, you might consider splitting `init.lua`
138-
into smaller parts. A fork of kickstart that does this while maintaining the
146+
into smaller parts. A fork of kickstart that does this while maintaining the
139147
same functionality is available here:
140148
* [kickstart-modular.nvim](https://github.com/dam9000/kickstart-modular.nvim)
141149
* Discussions on this topic can be found here:
@@ -174,7 +182,7 @@ run in cmd as **admin**:
174182
winget install --accept-source-agreements chocolatey.chocolatey
175183
```
176184

177-
2. install all requirements using choco, exit previous cmd and
185+
2. install all requirements using choco, exit the previous cmd and
178186
open a new one so that choco path is set, and run in cmd as **admin**:
179187
```
180188
choco install -y neovim git ripgrep wget fd unzip gzip mingw make
@@ -207,14 +215,14 @@ sudo apt update
207215
sudo apt install make gcc ripgrep unzip git xclip curl
208216
209217
# Now we install nvim
210-
curl -LO https://github.com/neovim/neovim/releases/latest/download/nvim-linux64.tar.gz
211-
sudo rm -rf /opt/nvim-linux64
212-
sudo mkdir -p /opt/nvim-linux64
213-
sudo chmod a+rX /opt/nvim-linux64
214-
sudo tar -C /opt -xzf nvim-linux64.tar.gz
218+
curl -LO https://github.com/neovim/neovim/releases/latest/download/nvim-linux-x86_64.tar.gz
219+
sudo rm -rf /opt/nvim-linux-x86_64
220+
sudo mkdir -p /opt/nvim-linux-x86_64
221+
sudo chmod a+rX /opt/nvim-linux-x86_64
222+
sudo tar -C /opt -xzf nvim-linux-x86_64.tar.gz
215223
216224
# make it available in /usr/local/bin, distro installs to /usr/bin
217-
sudo ln -sf /opt/nvim-linux64/bin/nvim /usr/local/bin/
225+
sudo ln -sf /opt/nvim-linux-x86_64/bin/nvim /usr/local/bin/
218226
```
219227
</details>
220228
<details><summary>Fedora Install Steps</summary>

0 commit comments

Comments
 (0)