1
mirror of https://github.com/neovim/neovim.git synced 2024-12-27 14:21:31 -07:00
Vim-fork focused on extensibility and usability
Go to file
2024-12-18 14:40:43 +00:00
.github ci(build.yml): disable security restriction 2024-12-16 16:26:19 +01:00
cmake build: mark CMake variables advanced 2024-12-09 16:10:27 -08:00
cmake.config test: port libvterm unit test to neovim test suite 2024-10-22 21:20:11 +02:00
cmake.deps build(deps): bump luajit to HEAD - f73e649a9 2024-12-16 17:08:52 +01:00
cmake.packaging fix(win-msi): set installer scope to machine 2024-08-12 12:11:40 -07:00
contrib docs: dev-arch, focusable windows 2024-10-07 08:27:38 -07:00
runtime Merge 551cb8712f into 7121983c45 2024-12-18 14:40:43 +00:00
scripts docs(annotations): added ---@generic support 2024-12-13 17:05:38 +00:00
src Merge 551cb8712f into 7121983c45 2024-12-18 14:40:43 +00:00
test Merge 551cb8712f into 7121983c45 2024-12-18 14:40:43 +00:00
.cirrus.yml vim-patch:9.0.1892: CI: no FreeBSD 14 support () 2023-12-16 21:12:31 +08:00
.clang-format build: align .clang-format rules with uncrustify config 2023-05-28 15:39:43 +02:00
.clang-tidy build: fix or silence new clang-tidy warnings 2024-09-25 16:09:08 +02:00
.clangd build: disable UnusedIncludes from clangd 2023-11-28 20:22:59 +01:00
.editorconfig fix(editorconfig): fix indent style for local.mk () 2024-11-24 22:04:27 -06:00
.git-blame-ignore-revs docs: .git-blame-ignore-revs 2024-01-28 15:03:10 -08:00
.gitattributes feat: generate types and docs for v variables 2023-12-21 14:19:10 +00:00
.gitignore vim-patch: make gen_opt_test.vim work with Nvim () 2024-10-18 17:38:29 +08:00
.luacheckrc test(lsp): refactor and tidy 2024-08-11 15:14:14 +01:00
.luacov
.luarc.json refactor: fix luals warnings 2023-12-30 17:40:53 +01:00
.mailmap docs: misc () 2024-06-07 10:55:14 +08:00
.stylua.toml build: enable lintlua for scripts/ dir 2023-12-04 12:38:31 -08:00
.styluaignore build: enable lintlua for test/ dir 2024-01-03 02:09:28 +01:00
BSDmakefile feat(lua)!: register_keystroke_callback => on_key 2021-09-09 06:09:33 -07:00
BUILD.md docs: misc 2024-12-13 14:21:12 +01:00
CMakeLists.txt build: mark CMake variables advanced 2024-12-09 16:10:27 -08:00
CMakePresets.json build: add "ci" configure preset to reduce verbosity 2023-04-23 17:12:46 +02:00
CONTRIBUTING.md docs: misc () 2024-06-07 10:55:14 +08:00
INSTALL.md docs: misc () 2024-08-29 06:11:32 +08:00
LICENSE.txt vim-patch:e978b4534a5e () 2023-08-13 13:25:10 +01:00
MAINTAIN.md fix(lua): vim.deprecate does not support major>0 2024-10-21 00:54:42 +02:00
Makefile docs: misc 2024-12-13 14:21:12 +01:00
README.md docs(tui): rename term.txt, nvim_terminal_emulator.txt 2024-09-18 00:26:01 -07:00

Neovim

Documentation | Chat

Coverity Scan analysis Packages Debian CI Downloads

Neovim is a project that seeks to aggressively refactor Vim in order to:

See the Introduction wiki page and Roadmap for more information.

Features

See :help nvim-features for the full list, and :help news for noteworthy changes in the latest version!

Install from package

Pre-built packages for Windows, macOS, and Linux are found on the Releases page.

Managed packages are in Homebrew, Debian, Ubuntu, Fedora, Arch Linux, Void Linux, Gentoo, and more!

Install from source

See BUILD.md and supported platforms for details.

The build is CMake-based, but a Makefile is provided as a convenience. After installing the dependencies, run the following command.

make CMAKE_BUILD_TYPE=RelWithDebInfo
sudo make install

To install to a non-default location:

make CMAKE_BUILD_TYPE=RelWithDebInfo CMAKE_INSTALL_PREFIX=/full/path/
make install

CMake hints for inspecting the build:

  • cmake --build build --target help lists all build targets.
  • build/CMakeCache.txt (or cmake -LAH build/) contains the resolved values of all CMake variables.
  • build/compile_commands.json shows the full compiler invocations for each translation unit.

Transitioning from Vim

See :help nvim-from-vim for instructions.

Project layout

├─ cmake/           CMake utils
├─ cmake.config/    CMake defines
├─ cmake.deps/      subproject to fetch and build dependencies (optional)
├─ runtime/         plugins and docs
├─ src/nvim/        application source code (see src/nvim/README.md)
│  ├─ api/          API subsystem
│  ├─ eval/         Vimscript subsystem
│  ├─ event/        event-loop subsystem
│  ├─ generators/   code generation (pre-compilation)
│  ├─ lib/          generic data structures
│  ├─ lua/          Lua subsystem
│  ├─ msgpack_rpc/  RPC subsystem
│  ├─ os/           low-level platform code
│  └─ tui/          built-in UI
└─ test/            tests (see test/README.md)

License

Neovim contributions since b17d96 are licensed under the Apache 2.0 license, except for contributions copied from Vim (identified by the vim-patch token). See LICENSE for details.

Vim is Charityware.  You can use and copy it as much as you like, but you are
encouraged to make a donation for needy children in Uganda.  Please see the
kcc section of the vim docs or visit the ICCF web site, available at these URLs:

        https://iccf-holland.org/
        https://www.vim.org/iccf/
        https://www.iccf.nl/

You can also sponsor the development of Vim.  Vim sponsors can vote for
features.  The money goes to Uganda anyway.