diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 67 |
1 files changed, 34 insertions, 33 deletions
@@ -1,61 +1,59 @@ - +[](https://neovim.io) -[Website](http://neovim.io) | -[Community](http://neovim.io/community/) | [Wiki](https://github.com/neovim/neovim/wiki) | -[Documentation](http://neovim.io/doc) | -[Mailing List](https://groups.google.com/forum/#!forum/neovim) | -[Twitter](http://twitter.com/Neovim) | -[Bountysource](https://www.bountysource.com/teams/neovim) +[Documentation](https://neovim.io/doc) | +[Twitter](https://twitter.com/Neovim) | +[Community](https://neovim.io/community/) | +[Gitter **Chat**](https://gitter.im/neovim/neovim) [](https://travis-ci.org/neovim/neovim) -[](https://ci.appveyor.com/project/neovim/neovim/branch/master) +[](https://ci.appveyor.com/project/neovim/neovim/branch/master) [](https://waffle.io/neovim/neovim) [](https://coveralls.io/r/neovim/neovim) [](https://scan.coverity.com/projects/2227) -[](http://neovim.io/doc/reports/clang) -[](https://gitter.im/neovim/neovim?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) +[](https://neovim.io/doc/reports/clang) +<a href="https://buildd.debian.org/neovim"><img src="https://www.debian.org/logos/openlogo-nd-25.png" width="13" height="15">Debian</a> Neovim is a project that seeks to aggressively refactor Vim in order to: -- Simplify maintenance and encourage [contributions](https://github.com/neovim/neovim/wiki/Contributing) +- Simplify maintenance and encourage [contributions](CONTRIBUTING.md) - Split the work between multiple developers -- Enable the implementation of new/modern user interfaces without any - modifications to the core source +- Enable advanced [external UIs] without modifications to the core - Improve extensibility with a new [plugin architecture](https://github.com/neovim/neovim/wiki/Plugin-UI-architecture) -For lots more details, see +For more details, see [the wiki](https://github.com/neovim/neovim/wiki/Introduction)! -### What's been done so far +[](https://waffle.io/neovim/neovim/metrics) + +What's been done so far +----------------------- -- Automatic [history merge](https://github.com/neovim/neovim/pull/2506) between multiple editor instances -- [XDG-compliant](https://github.com/neovim/neovim/pull/3470) configuration +- RPC API based on [MessagePack](https://msgpack.org) - Embedded [terminal emulator](https://neovim.io/doc/user/nvim_terminal_emulator.html) - Asynchronous [job control](https://github.com/neovim/neovim/pull/2247) -- [MessagePack](https://msgpack.org) remote API -- [Pushdown automaton](https://github.com/neovim/neovim/pull/3413) for state transitions - -See the [progress page](https://github.com/neovim/neovim/wiki/Progress) for a comprehensive list. +- [Shared data (shada)](https://github.com/neovim/neovim/pull/2506) among multiple editor instances +- [XDG base directories](https://github.com/neovim/neovim/pull/3470) support +- [libuv](https://github.com/libuv/libuv/)-based platform/OS/"mch" layer +- [Pushdown automaton](https://github.com/neovim/neovim/pull/3413) input model +- 1000s of new tests +- Legacy tests converted to Lua tests -[](https://waffle.io/neovim/neovim/metrics) +See [`:help nvim-features`][nvim-features] for a comprehensive list. -### What's being worked on now +What's being worked on now +-------------------------- -- Port all IO to [libuv](https://github.com/libuv/libuv/blob/master/README.md) -- Convert legacy tests to Lua tests -- VimL => Lua translator +See the [Roadmap]. -### How do I get it? +How do I get it? +---------------- -There is a formula for OSX/homebrew, a PKGBUILD for Arch Linux, RPM, deb, and +There is a Debian package, homebrew formula, PKGBUILD for Arch Linux, RPM, and more. See [the wiki](https://github.com/neovim/neovim/wiki/Installing-Neovim)! -### Contributing - -...would be awesome! See [the wiki](https://github.com/neovim/neovim/wiki/Contributing) for more details. - -### License +License +------- Neovim is licensed under the terms of the Apache 2.0 license, except for parts that were contributed under the Vim license. @@ -81,5 +79,8 @@ See `LICENSE` for details. features. The money goes to Uganda anyway. [license-commit]: https://github.com/neovim/neovim/commit/b17d9691a24099c9210289f16afb1a498a89d803 +[nvim-features]: https://neovim.io/doc/user/vim_diff.html#nvim-features +[Roadmap]: https://neovim.io/roadmap/ +[external UIs]: https://github.com/neovim/neovim/wiki/Related-projects#gui-projects <!-- vim: set tw=80: --> |