neovim/README.md

91 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) |
[Google Group](https://groups.google.com/forum/#!forum/neovim) |
[Twitter](http://twitter.com/Neovim) |
[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-03-30 04:57:23 -07:00
[![Coverage Status](https://coveralls.io/repos/neovim/neovim/badge.png)](https://coveralls.io/r/neovim/neovim)
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
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
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
- 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](https://github.com/neovim/neovim/pull/426)
- Formatted entire source with [uncrustify]
- Replaced autotools build system with [CMake]
- Implemented [continuous integration] and [test coverage]
2014-04-28 15:24:09 -07:00
- Wrote 100+ new unit tests
- Split large, monolithic files (`misc1.c`) into logical units
(`path.c`, `indent.c`, `garray.c`, `keymap.c`, ...)
2014-04-28 15:24:09 -07:00
- [Implemented](https://github.com/neovim/neovim/pull/475) job control ("async")
- Reworked out-of-memory handling resulting in greatly simplified control flow
- Merged 50+ upstream patches (nearly caught up with upstream)
- [Removed](https://github.com/neovim/neovim/pull/635) 8.3 filename support
- [Changed](https://github.com/neovim/neovim/pull/574) to portable format
specifiers (first step towards building on Windows)
2014-02-21 06:57:52 -07:00
2014-02-22 04:00:35 -07:00
[unifdef]: http://freecode.com/projects/unifdef
[uncrustify]: http://uncrustify.sourceforge.net/
[CMake]: http://cmake.org/
[continuous integration]: https://travis-ci.org/neovim/neovim
[test coverage]: https://coveralls.io/r/neovim/neovim
2014-02-21 06:57:52 -07:00
### What's being worked on now
2014-03-07 14:25:44 -07:00
- Porting all IO to libuv
- Lots of refactoring
- A VimL => Lua transpiler
- Formatting with `clint.py`
2014-04-28 15:24:09 -07:00
- msg-pack remote API
### How do I get it?
2014-03-07 14:25:44 -07:00
There is a formula for OSX/homebrew, a PKGBUILD for Arch Linux,
and detailed instructions for building on other OSes.
2014-03-07 14:25:44 -07:00
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
Vim itself is distributed under the terms of the Vim License.
See vim-license.txt for details.
Vim also includes this message:
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.
<!-- vim: set tw=80: -->