Go to file
Justin M. Keyes ede21f9518 NVIM v0.3.7
OTHER:
361d4be588 dist: update nvim.png
2019-05-29 10:57:53 +02:00
busted/outputHandlers test: Dump $NVIM_LOG_FILE contents (#8926) 2018-08-28 22:13:34 +02:00
ci ci: install neovim gem on macOS 2018-12-27 09:44:54 -05:00
cmake runtime/lua/vim/compat.lua 2018-12-20 11:57:30 +01:00
config *: Add some PVS comments 2018-04-15 20:07:07 +03:00
contrib contrib: fix local.mk.example (#8286) 2018-04-16 21:21:44 +02:00
man doc 2018-11-28 03:48:06 +01:00
runtime dist: update nvim.png 2019-05-29 01:29:24 +02:00
scripts genappimage.sh: migrate to linuxdeploy #10027 2019-05-18 21:34:37 +02:00
snap dist: snap packaging #7918 2018-01-29 23:02:15 +01:00
src vim-patch:8.1.1365: :source should check sandbox #10082 2019-05-29 00:33:22 +02:00
test options: properly reset directories on 'autochdir' (#9894) 2019-04-15 21:04:16 +02:00
third-party win/dist: nvim-qt v0.2.12 2019-01-13 01:27:36 +01:00
unicode Update unicode files 2018-07-10 06:53:11 -04:00
.clang-format lint: src/.clang-format 2018-11-28 03:48:06 +01:00
.editorconfig editorconfig: Fix charset name #9070 2018-09-30 17:02:19 +02:00
.gitignore makedeps.bat 2018-06-06 00:58:57 +02:00
.travis.yml Merge pull request #9433 from jamessan/only-lint-master 2019-01-01 09:23:37 -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 NVIM v0.3.7 2019-05-29 10:57:53 +02:00
CONTRIBUTING.md doc: job/channel, misc #7783 2018-06-11 00:08:27 +02:00
ISSUE_TEMPLATE.md doc: ISSUE_TEMPLATE.md 2017-07-08 14:59:06 +02:00
LICENSE LICENSE: add LuaJIT notice. #899 2014-06-30 13:59:56 -04:00
MAINTAIN.md doc: xdg, MAINTAIN.md, channel-id, job control 2018-10-11 19:32:31 +02:00
Makefile build: `make helphtml` 2018-11-05 22:45:48 +01:00
README.md doc 2018-12-30 21:09:39 +01:00
appveyor.yml CI/AppVeyor: invalidate .deps if build.ps1 changes 2018-10-22 01:28:02 +02:00
codecov.yml codecov: Tolerate a 1% drop in coverage for a PR 2018-12-02 23:10:58 -05:00

README.md

Neovim

Wiki | Documentation | Twitter | Community | Gitter Chat

Travis build status AppVeyor build status Codecov coverage Coverity Scan analysis Clang analysis PVS-Studio 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.

Throughput Graph

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

make CMAKE_BUILD_TYPE=RelWithDebInfo
sudo make install

To install to a non-default location, set CMAKE_INSTALL_PREFIX:

make CMAKE_EXTRA_FLAGS="-DCMAKE_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 libjemalloc-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
    

CMake features:

  • List all build targets:
    cmake --build build --target help
    
  • Print all variable definitions:
    cmake -LAH
    
  • build/CMakeCache.txt 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 is licensed under the terms of the Apache 2.0 license, except for parts that were contributed under the Vim license.

  • Contributions committed before b17d96 remain under the Vim license.

  • Contributions committed after b17d96 are licensed under Apache 2.0 unless those contributions were copied from Vim (identified in the commit logs 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.