No Description

zeertzjq be368a6f74 Merge pull request #17647 from neovim/backport-16851-to-release-0.6 2 years ago
.builds e2bc0bf665 fix(ci): adjust DEPS_INSTALL_DIR on OpenBSD to avoid pkg-config bug (#14803) 3 years ago
.github 8f3621c4b7 ci(commitlint): use lintcommit.lua from main repo 2 years ago
ci a92baa095a ci(windows): use the provided python from github actions 2 years ago
cmake d547d874af test: allow excluding functional/unit tests using TEST_FILTER_OUT 2 years ago
config caa6992a10 chore: fix typos (#16361) 3 years ago
contrib caa6992a10 chore: fix typos (#16361) 3 years ago
man cfa5d06801 docs(man): omit misleading mention of environment for -u NORC (#16379) 3 years ago
runtime 3a826ceed3 docs: update explanation of Y to reflect new defaults 2 years ago
scripts d89523ba62 ci: remove unused "squash typo" workflow 2 years ago
snap 192ea01edd cmake: install app icon in XDG hicolor icon theme (#14656) 3 years ago
src c624f260d3 vim-patch:8.2.3952: first line not redrawn when adding lines to an empty buffer 2 years ago
test c624f260d3 vim-patch:8.2.3952: first line not redrawn when adding lines to an empty buffer 2 years ago
third-party caa6992a10 chore: fix typos (#16361) 3 years ago
unicode aadf85f3ca Update unicode files 4 years ago
.clang-format 7146103be2 ci: increase clint line length limit to 100 characters (#15252) 3 years ago
.clangd 5777fc1b8e Adding clangd language serever config file to point to build/ directory for compile_commands.json 3 years ago
.editorconfig 0c42e0e8b1 editorconfig: set default tab width to 8 (#9467) 5 years ago
.flake8 d651710de1 ci: pylint target via flake8 5 years ago
.git-blame-ignore-revs 64f0fdc682 docs: .git-blame-ignore-revs #15775 3 years ago
.gitattributes d6f03aaafd fix: include ci/ in exported tarball 3 years ago
.gitignore 53f70bb183 chore: added ccls-cache in .gitignore (#15175) 3 years ago
.luacheckrc 736299bf22 build(lint): check scripts/*.lua 3 years ago
.luacov 678a51b1da Lua: vim.validate() 5 years ago
.travis.yml 035d82e0d3 build: update cmake min version to 3.10 #16065 3 years ago
BACKERS.md 846fe25111 Update backer URL 9 years ago
BSDmakefile 69fe427df4 feat(lua)!: register_keystroke_callback => on_key 3 years ago
CMakeLists.txt 6177030e4a version bump 2 years ago
CONTRIBUTING.md 3b531d50a8 docs(contrib): recommend `nvim --clean` #15917 3 years ago
LICENSE cb51a1b615 docs: add lua-cjson to third-party licenses #15800 3 years ago
MAINTAIN.md 6cc456deeb feat(ci): add backport PR action (#14766) 3 years ago
Makefile 7014731035 build: enhance Makefile 3 years ago
README.md 81f4de08bd docs: .git-blame-ignore-revs #15510 3 years ago
codecov.yml 3eb241d831 bundle: move tree-sitter as a bundled dep 4 years ago

README.md

Neovim

Documentation | Chat | Twitter

GitHub CI Codecov coverage Coverity Scan analysis Clang analysis PVS-Studio analysis

Packages Debian CI Downloads nvim

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!

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 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_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

├─ ci/              build automation
├─ cmake/           build scripts
├─ runtime/         user plugins/docs
├─ src/nvim/        application source code (see src/nvim/README.md)
│  ├─ api/          API subsystem
│  ├─ eval/         VimL 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
├─ third-party/     CMake subproject to build dependencies
└─ 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:

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

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