aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md46
1 files changed, 12 insertions, 34 deletions
diff --git a/README.md b/README.md
index 1eddbd9f6b..b8af1a61a3 100644
--- a/README.md
+++ b/README.md
@@ -1,7 +1,9 @@
![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) |
+[Wiki](https://github.com/neovim/neovim/wiki) |
+[Documentation](http://neovim.org/doc) |
+[Mailing List](https://groups.google.com/forum/#!forum/neovim) |
[Twitter](http://twitter.com/Neovim) |
[Reddit](http://www.reddit.com/r/neovim) |
[Bountysource](https://www.bountysource.com/teams/neovim)
@@ -11,59 +13,35 @@
[![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)
[![Clang Scan Build](http://neovim.org/doc/reports/clang/badge.svg)](http://neovim.org/doc/reports/clang)
-[![Bountysource](https://www.bountysource.com/badge/tracker?tracker_id=461131)](https://www.bountysource.com/trackers/461131-neovim?utm_source=461131&utm_medium=shield&utm_campaign=TRACKER_BADGE)
Neovim is a project that seeks to aggressively refactor Vim in order to:
-- Simplify maintenance and encourage contributions
+- Simplify maintenance and encourage [contributions](https://github.com/neovim/neovim/wiki/Contributing)
- 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
+- Improve extensibility with a new [plugin architecture](https://github.com/neovim/neovim/wiki/Plugin-UI-architecture)
For lots more details, see
[the wiki](https://github.com/neovim/neovim/wiki/Introduction)!
### 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](https://github.com/neovim/neovim/pull/426)
-- 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](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)
-
-[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
+- [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.
### What's being worked on now
-- Porting all IO to libuv
+- Port 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](https://github.com/neovim/neovim/wiki/Installing)!
+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