2014-04-11 10:36:58 -07:00
![Neovim ](https://raw.githubusercontent.com/neovim/neovim.github.io/master/logos/neovim-logo.png )
2015-04-19 13:17:45 -07:00
[Website ](http://neovim.io ) |
[Community ](http://neovim.io/community/ ) |
2014-05-20 11:17:43 -07:00
[Wiki ](https://github.com/neovim/neovim/wiki ) |
2015-04-19 13:17:45 -07:00
[Documentation ](http://neovim.io/doc ) |
2014-05-20 11:17:43 -07:00
[Mailing List ](https://groups.google.com/forum/#!forum/neovim ) |
2014-04-11 10:36:58 -07:00
[Twitter ](http://twitter.com/Neovim ) |
[Bountysource ](https://www.bountysource.com/teams/neovim )
2014-02-20 19:08:59 -07:00
2015-05-17 23:01:16 -07:00
[![Travis Build Status ](https://travis-ci.org/neovim/neovim.svg?branch=master )](https://travis-ci.org/neovim/neovim)
[![AppVeyor Build status ](https://ci.appveyor.com/api/projects/status/cf1jwc29198748we/branch/master?svg=true )](https://ci.appveyor.com/project/neovim/neovim/branch/master)
2014-11-14 10:27:54 -07:00
[![Pull requests waiting for review ](https://badge.waffle.io/neovim/neovim.svg?label=RFC&title=RFCs )](https://waffle.io/neovim/neovim)
2014-06-07 09:33:18 -07:00
[![Coverage Status ](https://img.shields.io/coveralls/neovim/neovim.svg )](https://coveralls.io/r/neovim/neovim)
2014-07-16 09:53:38 -07:00
[![Coverity Scan Build ](https://scan.coverity.com/projects/2227/badge.svg )](https://scan.coverity.com/projects/2227)
2015-04-19 13:17:45 -07:00
[![Clang Scan Build ](http://neovim.io/doc/reports/clang/badge.svg )](http://neovim.io/doc/reports/clang)
2015-03-16 04:14:00 -07:00
[![Join the chat at https://gitter.im/neovim/neovim ](https://badges.gitter.im/Join%20Chat.svg )](https://gitter.im/neovim/neovim?utm_source=badge& utm_medium=badge& utm_campaign=pr-badge& utm_content=badge)
2014-02-22 10:29:21 -07:00
2014-03-29 15:18:58 -07:00
Neovim is a project that seeks to aggressively refactor Vim in order to:
2014-02-24 11:48:18 -07:00
2014-05-20 11:17:43 -07:00
- Simplify maintenance and encourage [contributions ](https://github.com/neovim/neovim/wiki/Contributing )
2014-03-07 14:25:44 -07:00
- Split the work between multiple developers
2014-02-22 04:00:35 -07:00
- Enable the implementation of new/modern user interfaces without any
2014-03-07 14:25:44 -07:00
modifications to the core source
2014-05-20 11:17:43 -07:00
- Improve extensibility with a new [plugin architecture ](https://github.com/neovim/neovim/wiki/Plugin-UI-architecture )
2014-02-20 19:08:59 -07:00
2014-03-07 14:25:44 -07:00
For lots more details, see
[the wiki ](https://github.com/neovim/neovim/wiki/Introduction )!
2014-02-20 19:08:59 -07:00
2014-03-29 15:18:58 -07:00
### What's been done so far
2014-02-20 19:08:59 -07:00
2015-06-28 15:47:38 -07:00
- [Terminal emulator ](http://neovim.io/doc/user/nvim_terminal_emulator.html )
2015-04-25 21:02:03 -07:00
- [Job control ](https://github.com/neovim/neovim/pull/2247 )
2015-06-28 15:47:38 -07:00
- MessagePack-based remote API
2015-04-25 21:02:03 -07:00
- Performance, reliability, portability
See the [progress page ](https://github.com/neovim/neovim/wiki/Progress ) for a comprehensive list.
2014-02-21 06:57:52 -07:00
2014-11-14 10:32:03 -07:00
[![Throughput Graph ](https://graphs.waffle.io/neovim/neovim/throughput.svg )](https://waffle.io/neovim/neovim/metrics)
2014-03-29 15:18:58 -07:00
### What's being worked on now
2014-01-31 11:10:18 -07:00
2014-11-27 08:05:14 -07:00
- Port all IO to [libuv ](https://github.com/libuv/libuv/blob/master/README.md )
2015-04-25 21:02:03 -07:00
- Convert legacy tests to Lua tests
- VimL => Lua translator
2014-01-31 11:10:18 -07:00
2014-03-29 15:18:58 -07:00
### How do I get it?
2014-01-31 11:10:18 -07:00
2014-05-20 11:17:43 -07:00
There is a formula for OSX/homebrew, a PKGBUILD for Arch Linux, RPM, deb, and
2015-04-02 14:46:08 -07:00
more. See [the wiki ](https://github.com/neovim/neovim/wiki/Installing-Neovim )!
2014-02-23 14:28:31 -07:00
2014-03-29 15:18:58 -07:00
### Contributing
2014-02-22 08:26:49 -07:00
...would be awesome! See [the wiki ](https://github.com/neovim/neovim/wiki/Contributing ) for more details.
2014-03-29 15:18:58 -07:00
### License
2014-02-22 04:57:44 -07:00
2014-06-27 15:32:58 -07:00
Neovim is licensed under the terms of the Apache 2.0 license, except for
parts that were contributed under the Vim license.
2015-10-26 22:07:24 -07:00
- Contributions committed before [b17d96][license-commit] remain under the Vim
license.
2014-06-27 15:32:58 -07:00
- Contributions committed after [b17d96][license-commit] are licensed under
2015-03-16 10:52:13 -07:00
Apache 2.0 unless those contributions were copied from Vim (identified in
2014-06-27 15:32:58 -07:00
the commit logs by the `vim-patch` token).
2014-06-30 10:59:56 -07:00
See `LICENSE` for details.
2014-02-22 04:57:44 -07:00
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.
2014-06-30 01:37:41 -07:00
[license-commit]: https://github.com/neovim/neovim/commit/b17d9691a24099c9210289f16afb1a498a89d803
2014-06-27 15:32:58 -07:00
2014-02-22 05:50:34 -07:00
<!-- vim: set tw=80: -->