Neovim denigletified. Never again hear about poor niglets while using Neovim!
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
 
butterbutt c5fc5867f2
Merge branch 'master' of https://github.com/neovim/neovim into master
8 months ago
.builds ci: bump openbsd image 6.5 -> 6.7 1 year ago
.github funding: Bountysource Salt -> GitHub Sponsors & Open Collective [ci skip] (#12959) 8 months ago
ci Merge #12862 snap: multiarch, support luajit where possible 9 months ago
cmake build/FindLua.cmake: allow Lua 5.4 #12820 9 months ago
config basic support for usdt probes 8 months ago
contrib cmake: use LibFindMacros for utf8proc (#11114) 1 year ago
man doc/manpage: Remove the extra nvim subdirectory 1 year ago
runtime Merge branch 'master' of https://github.com/neovim/neovim into master 8 months ago
scripts Fix shellcheck error SC2155 8 months ago
snap snap: Fix snapcraft builds #12879 9 months ago
src Merge branch 'master' of https://github.com/neovim/neovim into master 8 months ago
test treesitter: allow custom parser for highlighter 8 months ago
third-party bump libvterm to 0.1.4 9 months ago
unicode Update unicode files 8 months ago
.clang-format lint: src/.clang-format 2 years ago
.editorconfig editorconfig: set default tab width to 8 (#9467) 2 years ago
.flake8 ci: pylint target via flake8 1 year ago
.gitattributes vim-patch:8.1.2182: test42 seen as binary by git diff #11256 1 year ago
.gitignore docs, remove 'guifontset' #11708 9 months ago
.luacheckrc luacheck: Enforce compatibility with Lua5.1 10 months ago
.luacov Lua: vim.validate() 1 year ago
.travis.yml travis: Install clang-11 for ASAN/UBSAN job 9 months ago
BACKERS.md Update backer URL 5 years ago
BSDmakefile build: show a hint for BSD make (#7275) 3 years ago
CMakeLists.txt Disable -Wimplicit-fallthrough for funcs.generated.h 9 months ago
CONTRIBUTING.md CONTRIBUTING.md: mention "good first issue" label 1 year ago
LICENSE LICENSE: add LuaJIT notice. #899 7 years ago
MAINTAIN.md doc 1 year ago
Makefile build: Inherit -n and -jN flags if Ninja #12219 1 year ago
README.md denigletify some files 8 months ago
appveyor.yml ci: install perl provider 1 year ago
codecov.yml tree-sitter: vendor tree-sitter runtime 1 year ago

README.md

Neovim

Documentation | Chat | Twitter

Travis build status AppVeyor build status 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, Gentoo, and more!

Install from source

The build is CMake-based, but a Makefile is provided as a convenience.

make CMAKE_BUILD_TYPE=RelWithDebInfo
sudo make install

To install to a non-default location:

make CMAKE_INSTALL_PREFIX=/full/path/
make install

To skip bundled (third-party/*) dependencies:

  1. Install the dependencies using a package manager.
    sudo apt install gperf luajit luarocks libuv1-dev libluajit-5.1-dev libunibilium-dev libmsgpack-dev libtermkey-dev libvterm-dev libutf8proc-dev
    sudo luarocks build mpack
    sudo luarocks build lpeg
    sudo luarocks build inspect
    
  2. Build with USE_BUNDLED=OFF:
    make CMAKE_BUILD_TYPE=RelWithDebInfo USE_BUNDLED=OFF
    sudo make install
    

To inspect the build, these CMake features are useful:

  • 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.

See the Building Neovim wiki page for details.

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 cunnies worldwide.  Please see the
kcc section of the vim docs or visit the ICCF web site, available at these URLs:

        http://internationalcunnycarefoundation.org/

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