neovim/README.md

Website | Google Group | Twitter | Reddit | Bountysource

Neovim is a project that seeks to aggressively refactor Vim in order to:

• Simplify maintenance and encourage contributions
• Split the work between multiple developers
• Enable the implementation of new/modern user interfaces without any modifications to the core source
• Improve extensibility with a new plugin architecture

For lots more details, see the wiki!

What's been done so far

• Cleaned up source tree, leaving only core files
• Removed support for legacy systems and moved to C99
  • Removed tons of FEAT_* macros with unifdef
  • Reduced C code from 300k lines to 170k
• Enabled modern compiler features and optimizations
• Formatted entire source with uncrustify
• Replaced autotools build system with CMake
• Implemented continuous integration and test coverage
• Wrote 100+ new unit tests
• Split large, monolithic files (misc1.c) into logical units (path.c, indent.c, garray.c, keymap.c, ...)
• Implemented job control ("async")
• Reworked out-of-memory handling resulting in greatly simplified control flow
• Merged 50+ upstream patches (nearly caught up with upstream)
• Removed 8.3 filename support
• Changed to portable format specifiers (first step towards building on Windows)

What's being worked on now

• Porting all IO to libuv
• Lots of refactoring
• A VimL => Lua transpiler
• Formatting with clint.py
• msg-pack remote API

How do I get it?

There is a formula for OSX/homebrew, a PKGBUILD for Arch Linux, and detailed instructions for building on other OSes.

See the wiki!

Community

Join the community on IRC in #neovim on Freenode or the mailing list

Contributing

...would be awesome! See the wiki for more details.

License

Vim itself is distributed under the terms of the Vim License. See vim-license.txt for details.

Vim also includes this message:

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.