Go to file
Justin M. Keyes 1c3ca4f18f mksession: always unix slashes "/" for filepaths 2020-01-26 17:30:47 -08:00
.builds ci: SourceHut: revisit OpenBSD/FreeBSD config 2019-12-01 06:44:35 +01:00
.github doc [ci skip] #10177 2019-06-30 00:09:45 +02:00
ci mksession: always unix slashes "/" for filepaths 2020-01-26 17:30:47 -08:00
cmake build: run git-describe for dev version during build (#11117) 2019-09-30 00:10:29 +02:00
config Fix/revisit git-describe enhancement (#11124) 2019-10-02 03:45:59 +02:00
contrib cmake: use LibFindMacros for utf8proc (#11114) 2019-09-29 04:44:02 +02:00
man doc 2019-09-09 09:53:19 -07:00
runtime mksession: always unix slashes "/" for filepaths 2020-01-26 17:30:47 -08:00
scripts terminal: absolute CWD in term:// URI #11289 2020-01-26 00:24:42 -08:00
snap snap: set "classic" confinement #11601 2019-12-24 06:43:25 +01:00
src mksession: always unix slashes "/" for filepaths 2020-01-26 17:30:47 -08:00
test mksession: always unix slashes "/" for filepaths 2020-01-26 17:30:47 -08:00
third-party third-party: upgrade libvterm to v0.1.3 (#11678) 2020-01-07 20:12:56 +01:00
unicode vim-patch:8.1.1470: new doublewidth Unicode character U32FF #10126 2019-06-06 11:35:23 +02:00
.clang-format lint: src/.clang-format 2018-11-28 03:48:06 +01:00
.editorconfig editorconfig: set default tab width to 8 (#9467) 2019-01-07 02:15:19 +01:00
.flake8 ci: pylint target via flake8 2019-07-29 22:14:23 +02:00
.gitattributes vim-patch:8.1.2182: test42 seen as binary by git diff #11256 2019-10-19 11:31:50 -07:00
.gitignore vim-patch:8.1.2402: typos and other small things 2019-12-07 11:48:55 -05:00
.luacheckrc Lua: vim.env, vim.{g,v,w,bo,wo} #11442 2019-11-24 02:28:48 -08:00
.luacov Lua: vim.validate() 2019-11-10 22:50:24 -08:00
.travis.yml ci: install perl provider 2020-01-20 19:43:58 -05:00
BACKERS.md Update backer URL 2015-11-11 19:50:33 -08:00
BSDmakefile build: show a hint for BSD make (#7275) 2017-09-16 10:54:49 +02:00
CMakeLists.txt build: CMakeLists: do not set MIN_LOG_LEVEL with C flags (#11498) 2019-12-02 17:12:51 +01:00
CONTRIBUTING.md doc [ci skip] #11656 2020-01-12 23:41:55 -08:00
LICENSE LICENSE: add LuaJIT notice. #899 2014-06-30 13:59:56 -04:00
MAINTAIN.md doc 2019-09-09 09:53:19 -07:00
Makefile oldtest: support for running by filename (#11473) 2019-12-02 17:18:37 +01:00
README.md doc [ci skip] 2019-12-31 02:25:10 -08:00
appveyor.yml ci: install perl provider 2020-01-20 19:43:58 -05:00
codecov.yml tree-sitter: vendor tree-sitter runtime 2019-09-28 14:30:48 +02:00

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