https://github.com/twfksh/nvim
https://github.com/twfksh/nvim
Last synced: over 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/twfksh/nvim
- Owner: twfksh
- License: mit
- Created: 2024-04-23T17:45:21.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-07-17T08:09:33.000Z (almost 2 years ago)
- Last Synced: 2025-01-22T13:40:19.083Z (over 1 year ago)
- Language: Lua
- Size: 77.1 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
## Introduction
A Neovim configuration that is small and modular.
## Installation
### Install Neovim
This neovim configuration targets *only* the latest
['stable'](https://github.com/neovim/neovim/releases/tag/stable) and latest
['nightly'](https://github.com/neovim/neovim/releases/tag/nightly) of Neovim.
If you are experiencing issues, please make sure you have the latest versions.
### Install External Dependencies
External Requirements:
- Basic utils: `git`, `make`, `unzip`, C Compiler (`gcc`)
- [ripgrep](https://github.com/BurntSushi/ripgrep#installation)
- 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
- Language Setup:
- If want to write Typescript, you need `npm`
- If want to write Golang, you will need `go`
- etc.
### Install
> **NOTE**
> [Backup](#FAQ) your previous configuration (if any exists)
Neovim's configurations are located under the following paths, depending on your OS:
| OS | PATH |
| :- | :--- |
| Linux, MacOS | `$XDG_CONFIG_HOME/nvim`, `~/.config/nvim` |
| Windows (cmd)| `%userprofile%\AppData\Local\nvim\` |
| Windows (powershell)| `$env:USERPROFILE\AppData\Local\nvim\` |
#### Clone nvim
Linux and Mac
```sh
git clone https://github.com/twfksh/nvim.git "${XDG_CONFIG_HOME:-$HOME/.config}"/nvim
```
Windows
If you're using `cmd.exe`:
```
git clone https://github.com/twfksh/nvim.git %userprofile%\AppData\Local\nvim\
```
If you're using `powershell.exe`
```
git clone https://github.com/twfksh/nvim.git $env:USERPROFILE\AppData\Local\nvim\
```
### Post Installation
Start Neovim
```sh
nvim
```
That's it! Lazy will install some plugin. Use `:Lazy` to view
current plugin status. Hit `q` to close the window.