neovim/README.md

82 lines
3.5 KiB
Markdown
Raw Normal View History

2014-04-11 10:36:58 -07:00
![Neovim](https://raw.githubusercontent.com/neovim/neovim.github.io/master/logos/neovim-logo.png)
[Website](http://neovim.org) |
[Wiki](https://github.com/neovim/neovim/wiki) |
[Documentation](http://neovim.org/doc) |
[Mailing List](https://groups.google.com/forum/#!forum/neovim) |
2014-04-11 10:36:58 -07:00
[Twitter](http://twitter.com/Neovim) |
2014-05-08 07:11:37 -07:00
[Reddit](http://www.reddit.com/r/neovim) |
2014-04-11 10:36:58 -07:00
[Bountysource](https://www.bountysource.com/teams/neovim)
2014-02-20 19:08:59 -07:00
2014-04-24 02:41:27 -07:00
[![Build Status](https://travis-ci.org/neovim/neovim.svg?branch=master)](https://travis-ci.org/neovim/neovim)
2014-02-24 10:16:21 -07:00
[![Stories in Ready](https://badge.waffle.io/neovim/neovim.png?label=ready)](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)
[![Coverity Scan Build](https://scan.coverity.com/projects/2227/badge.svg)](https://scan.coverity.com/projects/2227)
2014-08-20 13:21:21 -07:00
[![Clang Scan Build](http://neovim.org/doc/reports/clang/badge.svg)](http://neovim.org/doc/reports/clang)
2014-02-22 10:29:21 -07:00
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)
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
- 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
### What's been done so far
2014-02-20 19:08:59 -07:00
- [Job control](https://github.com/neovim/neovim/pull/475) (work with processes asynchronously)
- msgpack remote API
- Performance, reliability, and portability improvements
- See the [progress page](https://github.com/neovim/neovim/wiki/Progress) for a comprehensive list.
2014-02-21 06:57:52 -07:00
### What's being worked on now
- Port all IO to [libuv](https://github.com/joyent/libuv/blob/master/README.md)
2014-03-07 14:25:44 -07:00
- Lots of refactoring
- A VimL => Lua transpiler
### How do I get it?
There is a formula for OSX/homebrew, a PKGBUILD for Arch Linux, RPM, deb, and
more. See [the wiki](https://github.com/neovim/neovim/wiki/Installing)!
### Community
2014-02-24 14:24:30 -07:00
Join the community on IRC in #neovim on Freenode or the [mailing list](https://groups.google.com/forum/#!forum/neovim)
2014-02-22 04:57:44 -07:00
### Contributing
...would be awesome! See [the wiki](https://github.com/neovim/neovim/wiki/Contributing) for more details.
### 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.
- Contributions committed before [b17d96][license-commit] by authors who did
not sign the Contributor License Agreement (CLA) remain under the Vim license.
- Contributions committed after [b17d96][license-commit] are licensed under
Apache 2.0 unless those contributions were copied from Vim (identified in
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
<!-- vim: set tw=80: -->