Skip to content

Sync fork changes #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 25 commits into from
Apr 10, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
25 commits
Select commit Hold shift + click to select a range
e84e187
Fix README.md grammar and typos (#1291)
feketegy Dec 29, 2024
7ddaab3
chore: add pre-issue requirements (#1288)
iton0 Dec 29, 2024
a8f5395
Fix which-key delay settings (#1276)
jensenr30 Dec 29, 2024
db4867a
fix: prevent mason setup from being run twice (#1298)
tomasgareau Jan 7, 2025
f6abf68
chore: remove redundant comment (#1307)
nhld Jan 15, 2025
ff89769
chore: fix typo in bug report issue template (#1306)
nhld Jan 15, 2025
5bdde24
Use luals 3rd library for luv (#1303)
diorman Jan 15, 2025
abdbfce
chore(docs): Update README.md (#1344)
rnevius Feb 15, 2025
71ad926
docs: clarify using opts = {} vs config = function() ... require('plu…
bleacheda Feb 15, 2025
94f551b
fix (#1319): gitsigns deprecated functions (#1321)
ErlanRG Feb 15, 2025
d2c0068
Add a blurb about installing missing emoji on Ubuntu
feoh Feb 17, 2025
db78c0b
fix: arguments for the `vim.lsp.Client.supports_method` method (#1356)
TungstnBallon Feb 17, 2025
76e06fe
feat(diagnostic): add diagnostic config (#1335)
gelocraft Feb 17, 2025
ebca680
perf: load tokyonight.nvim in the intended way (#1360)
warbacon Feb 18, 2025
282cbb9
feat: add basic function signature help (#1358)
rfletchr Feb 18, 2025
7c49ba1
Fix: fix the cmp-nvim-lsp-signature-help link (#1363)
aryan-rajoria Feb 18, 2025
e64aa51
fix: regression introduced in db78c0b217fd9525e2cbcbffd18abbbbddc75b2…
TungstnBallon Feb 18, 2025
ea60b2b
Remove duplicate cmp-path (#1369)
aripollak Feb 19, 2025
34e7d29
Propsed fix for init.lua warnings as per https://github.com/nvim-lua/…
feoh Feb 19, 2025
38f4744
feat: add `vim.opt.confirm = true` (#1384)
Crypto-Spartan Mar 12, 2025
2abcb39
fix: use correct github abmonition syntax (#1414)
saccarosium Mar 20, 2025
5e2d7e1
changed Conform's format_on_save lambda so that buffers that match di…
RulentWave Mar 24, 2025
e947649
feat(keymap): move windows without `<C-w>` (#1368)
sand4rt Mar 24, 2025
ac130b1
Merge remote-tracking branch 'upstream/master'
hielfx Apr 6, 2025
36e4740
chore: update lazy lock
hielfx Apr 6, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 9 additions & 2 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,13 @@ assignees: ''

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

## Before Reporting an Issue
- I have read the kickstart.nvim README.md.
- I have read the appropriate plugin's documentation.
- I have searched that this issue has not been reported before.

- [ ] **By checking this, I confirm that the above steps are completed. I understand leaving this unchecked will result in this report being closed immediately.**

## Describe the bug
<!-- A clear and concise description of what the bug is. -->

Expand All @@ -18,8 +25,8 @@ assignees: ''

## Desktop
<!-- please complete the following information. -->
- OS:
- Terminal:
- OS:
- Terminal:

## Neovim Version
<!-- Output of running `:version` from inside of neovim. -->
Expand Down
43 changes: 25 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,21 +24,22 @@ If you are experiencing issues, please make sure you have the latest versions.
External Requirements:
- Basic utils: `git`, `make`, `unzip`, C Compiler (`gcc`)
- [ripgrep](https://github.com/BurntSushi/ripgrep#installation)
- Clipboard tool (xclip/xsel/win32yank or other depending on platform)
- Clipboard tool (xclip/xsel/win32yank or other depending on the platform)
- A [Nerd Font](https://www.nerdfonts.com/): optional, provides various icons
- if you have it set `vim.g.have_nerd_font` in `init.lua` to true
- Emoji fonts (Ubuntu only, and only if you want emoji!) `sudo apt install fonts-noto-color-emoji`
- Language Setup:
- If you want to write Typescript, you need `npm`
- If you want to write Golang, you will need `go`
- etc.

> **NOTE**
> [!NOTE]
> See [Install Recipes](#Install-Recipes) for additional Windows and Linux specific notes
> and quick install snippets

### Install Kickstart

> **NOTE**
> [!NOTE]
> [Backup](#FAQ) your previous configuration (if any exists)

Neovim's configurations are located under the following paths, depending on your OS:
Expand All @@ -55,16 +56,17 @@ Neovim's configurations are located under the following paths, depending on your
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:
> [!NOTE]
> Your fork's URL will be something like this:
> `https://github.com/<your_github_username>/kickstart.nvim.git`

You likely want to remove `lazy-lock.json` from your fork's `.gitignore` file
too - it's ignored in the kickstart repo to make maintenance easier, but it's
[recommmended to track it in version control](https://lazy.folke.io/usage/lockfile).
[recommended to track it in version control](https://lazy.folke.io/usage/lockfile).

#### Clone kickstart.nvim
> **NOTE**

> [!NOTE]
> If following the recommended step above (i.e., forking the repo), replace
> `nvim-lua` with `<your_github_username>` in the commands below

Expand Down Expand Up @@ -101,22 +103,27 @@ nvim
```

That's it! Lazy will install all the plugins you have. Use `:Lazy` to view
current plugin status. Hit `q` to close the window.
the current plugin status. Hit `q` to close the window.

#### Read The Friendly Documentation

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

> [!NOTE]
> For more information about a particular plugin check its repository's documentation.


### 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?
* 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`
* 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`
Expand All @@ -135,7 +142,7 @@ examples of adding popularly requested plugins.
* The main purpose of kickstart is to serve as a teaching tool and a reference
configuration that someone can easily use to `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
into smaller parts. A fork of kickstart that does this while maintaining the
same functionality is available here:
* [kickstart-modular.nvim](https://github.com/dam9000/kickstart-modular.nvim)
* Discussions on this topic can be found here:
Expand Down Expand Up @@ -174,7 +181,7 @@ run in cmd as **admin**:
winget install --accept-source-agreements chocolatey.chocolatey
```

2. install all requirements using choco, exit previous cmd and
2. install all requirements using choco, exit the previous cmd and
open a new one so that choco path is set, and run in cmd as **admin**:
```
choco install -y neovim git ripgrep wget fd unzip gzip mingw make
Expand Down Expand Up @@ -207,14 +214,14 @@ sudo apt update
sudo apt install make gcc ripgrep unzip git xclip curl

# Now we install nvim
curl -LO https://github.com/neovim/neovim/releases/latest/download/nvim-linux64.tar.gz
sudo rm -rf /opt/nvim-linux64
sudo mkdir -p /opt/nvim-linux64
sudo chmod a+rX /opt/nvim-linux64
sudo tar -C /opt -xzf nvim-linux64.tar.gz
curl -LO https://github.com/neovim/neovim/releases/latest/download/nvim-linux-x86_64.tar.gz
sudo rm -rf /opt/nvim-linux-x86_64
sudo mkdir -p /opt/nvim-linux-x86_64
sudo chmod a+rX /opt/nvim-linux-x86_64
sudo tar -C /opt -xzf nvim-linux-x86_64.tar.gz

# make it available in /usr/local/bin, distro installs to /usr/bin
sudo ln -sf /opt/nvim-linux64/bin/nvim /usr/local/bin/
sudo ln -sf /opt/nvim-linux-x86_64/bin/nvim /usr/local/bin/
```
</details>
<details><summary>Fedora Install Steps</summary>
Expand Down
Loading