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
2023-11-27 21:53:07 +01:00
.github ci: fix api-docs workflow 2023-11-27 14:44:03 +01:00
cmake docs: small fixes () 2023-11-27 17:43:13 +08:00
cmake.config build(IWYU): export generated headers 2023-11-27 19:33:42 +01:00
cmake.deps fixup: quick update, squash later 2023-11-20 15:21:55 +01:00
cmake.packaging build!: remove neovim qt 2023-06-06 19:19:00 +02:00
contrib build: remove luarocks 2023-09-10 15:32:47 +02:00
runtime docs: support @since for api level 2023-11-27 08:23:04 -08:00
scripts docs: support @since for api level 2023-11-27 08:23:04 -08:00
src refactor: fix includes for api/autocmd.h 2023-11-27 21:53:07 +01:00
test fix(treesitter): don't invalidate parser when discovering injections 2023-11-27 15:53:26 +01:00
.cirrus.yml ci(cirrus): use FreeBSD 13.2 () 2023-09-11 12:41:53 +08:00
.clang-format build: align .clang-format rules with uncrustify config 2023-05-28 15:39:43 +02:00
.clang-tidy build: adjust clang-tidy warning exclusion logic 2023-11-20 20:05:43 +01:00
.clangd Adding clangd language serever config file to point to build/ directory for compile_commands.json 2021-06-28 11:03:09 -04:00
.editorconfig build(editorconfig): set indent_size to 4 for python files () 2022-11-21 06:53:29 -07:00
.git-blame-ignore-revs docs: .git-blame-ignore-revs () 2022-10-27 20:31:09 +02:00
.gitattributes docs(options): take ownership of options.txt () 2023-08-04 21:26:53 +01:00
.gitignore feat: add .luarc.json () 2023-08-07 16:27:53 +01:00
.luacheckrc feat(lua-types): types for vim.api.* () 2023-08-01 14:20:44 +01:00
.luacov Lua: vim.validate() 2019-11-10 22:50:24 -08:00
.luarc.json fix(luarc.json): ignore test directory to save memory 2023-08-23 14:25:36 +01:00
.mailmap docs: update .mailmap () 2022-09-06 08:57:03 +02:00
.stylua.toml refactor(lua): reformat with stylua 0.14.0 () 2022-07-07 18:27:18 +02:00
.styluaignore build: use stylua with add_glob_target 2023-11-12 20:19:10 +01:00
BACKERS.md
BSDmakefile feat(lua)!: register_keystroke_callback => on_key 2021-09-09 06:09:33 -07:00
CMakeLists.txt build: reorganize cmake files 2023-11-21 22:18:21 +01:00
CMakePresets.json build: add "ci" configure preset to reduce verbosity 2023-04-23 17:12:46 +02:00
CONTRIBUTING.md build: remove PVS 2023-11-12 21:26:39 +01:00
LICENSE.txt vim-patch:e978b4534a5e () 2023-08-13 13:25:10 +01:00
MAINTAIN.md docs: small fixes () 2023-11-27 17:43:13 +08:00
Makefile refactor: fix includes for api/autocmd.h 2023-11-27 21:53:07 +01:00
README.md build: remove PVS 2023-11-12 21:26:39 +01:00

Neovim

Documentation | Chat

Coverity Scan analysis Clang 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 the Building Neovim wiki page 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.