aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorJustin M. Keyes <justinkz@gmail.com>2016-08-10 00:47:04 -0400
committerJustin M. Keyes <justinkz@gmail.com>2016-08-10 00:47:17 -0400
commitdb375102ead998421a180525299f66db3e6127f3 (patch)
tree83d1728869424b254c8bff864791d456dba661eb /README.md
parent3b785b32f9c85f6f2547a509fb6faa4a717f19cf (diff)
downloadrneovim-db375102ead998421a180525299f66db3e6127f3.tar.gz
rneovim-db375102ead998421a180525299f66db3e6127f3.tar.bz2
rneovim-db375102ead998421a180525299f66db3e6127f3.zip
doc
Diffstat (limited to 'README.md')
-rw-r--r--README.md57
1 files changed, 32 insertions, 25 deletions
diff --git a/README.md b/README.md
index 63c7dd95d7..03d478d42c 100644
--- a/README.md
+++ b/README.md
@@ -1,12 +1,6 @@
![Neovim](https://raw.githubusercontent.com/neovim/neovim.github.io/master/logos/neovim-logo.png)
-[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)
+[Website] | [Community] | [Wiki] | [Documentation] | [Mailing List] | [Twitter] | [Bountysource]
[![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)
@@ -14,44 +8,48 @@
[![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.io/doc/reports/clang/badge.svg)](http://neovim.io/doc/reports/clang)
-[![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)
+[![Gitter chat](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)
Neovim is a project that seeks to aggressively refactor Vim in order to:
- 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 the implementation of new/modern 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
+[![Throughput Graph](https://graphs.waffle.io/neovim/neovim/throughput.svg)](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
+- [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
-See the [progress page](https://github.com/neovim/neovim/wiki/Progress) for a comprehensive list.
-
-[![Throughput Graph](https://graphs.waffle.io/neovim/neovim/throughput.svg)](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/)
-- 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
more. See [the wiki](https://github.com/neovim/neovim/wiki/Installing-Neovim)!
-### License
+License
+-------
Neovim is licensed under the terms of the Apache 2.0 license, except for
parts that were contributed under the Vim license.
@@ -76,6 +74,15 @@ See `LICENSE` for details.
You can also sponsor the development of Vim. Vim sponsors can vote for
features. The money goes to Uganda anyway.
+[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
[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/
<!-- vim: set tw=80: -->