diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 94 |
1 files changed, 65 insertions, 29 deletions
@@ -1,4 +1,4 @@ -[](https://neovim.io) +[](https://neovim.io) [Wiki](https://github.com/neovim/neovim/wiki) | [Documentation](https://neovim.io/doc) | @@ -8,49 +8,79 @@ [](https://travis-ci.org/neovim/neovim) [](https://ci.appveyor.com/project/neovim/neovim/branch/master) -[](https://waffle.io/neovim/neovim) -[](https://coveralls.io/r/neovim/neovim) +[](https://codecov.io/gh/neovim/neovim) [](https://scan.coverity.com/projects/2227) [](https://neovim.io/doc/reports/clang) +[](https://neovim.io/doc/reports/pvs) + <a href="https://buildd.debian.org/neovim"><img src="https://www.debian.org/logos/openlogo-nd-25.png" width="13" height="15">Debian</a> +[](https://github.com/neovim/neovim/releases/) 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 advanced [external UIs] without modifications to the core -- Improve extensibility with a new [plugin architecture](https://github.com/neovim/neovim/wiki/Plugin-UI-architecture) +- Enable [advanced UIs] without modifications to the core +- Maximize [extensibility](https://github.com/neovim/neovim/wiki/Plugin-UI-architecture) -For more details, see -[the wiki](https://github.com/neovim/neovim/wiki/Introduction)! +See [the wiki](https://github.com/neovim/neovim/wiki/Introduction) and [Roadmap] +for more information. [](https://waffle.io/neovim/neovim/metrics) -What's been done so far ------------------------ - -- RPC API based on [MessagePack](https://msgpack.org) -- Embedded [terminal emulator](https://neovim.io/doc/user/nvim_terminal_emulator.html) +Install from source +------------------- + + make CMAKE_BUILD_TYPE=RelWithDebInfo + sudo make install + +See [the wiki](https://github.com/neovim/neovim/wiki/Building-Neovim) for details. + +Install from package +-------------------- + +Pre-built packages for Windows, macOS, and Linux are found at the +[Releases](https://github.com/neovim/neovim/releases/) page. + +Managed packages are in [Homebrew], [Debian], [Ubuntu], [Fedora], [Arch Linux], [Gentoo], +and [more](https://github.com/neovim/neovim/wiki/Installing-Neovim)! + +Project layout +-------------- + + ├─ ci/ build automation + ├─ cmake/ build scripts + ├─ runtime/ user plugins/docs + ├─ src/ application source code (see src/nvim/README.md) + │ ├─ api/ API subsystem + │ ├─ eval/ VimL subsystem + │ ├─ event/ event-loop subsystem + │ ├─ generators/ code generation (pre-compilation) + │ ├─ lib/ generic data structures + │ ├─ lua/ lua subsystem + │ ├─ msgpack_rpc/ RPC subsystem + │ ├─ os/ low-level platform code + │ └─ tui/ built-in UI + ├─ third-party/ cmake subproject to build dependencies + └─ test/ tests (see test/README.md) + +- To disable `third-party/` specify `USE_BUNDLED_DEPS=NO` or `USE_BUNDLED=NO` + (CMake option). + +Features +-------- + +- Modern [GUIs](https://github.com/neovim/neovim/wiki/Related-projects#gui) +- [API](https://github.com/neovim/neovim/wiki/Related-projects#api-clients) + access from any language including clojure, lisp, go, haskell, lua, + javascript, perl, python, ruby, rust. +- Embedded, scriptable [terminal emulator](https://neovim.io/doc/user/nvim_terminal_emulator.html) - Asynchronous [job control](https://github.com/neovim/neovim/pull/2247) - [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 [`:help nvim-features`][nvim-features] for a comprehensive list. - -What's being worked on now --------------------------- - -See the [Roadmap]. - -How do I get it? ----------------- +- Compatible with most Vim plugins, including Ruby and Python plugins. -There is a Debian package, homebrew formula, PKGBUILD for Arch Linux, RPM, and -more. See [the wiki](https://github.com/neovim/neovim/wiki/Installing-Neovim)! +See [`:help nvim-features`][nvim-features] for the full list! License ------- @@ -81,6 +111,12 @@ See `LICENSE` for details. [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/ -[external UIs]: https://github.com/neovim/neovim/wiki/Related-projects#gui-projects +[advanced UIs]: https://github.com/neovim/neovim/wiki/Related-projects#gui +[Homebrew]: https://github.com/neovim/homebrew-neovim#installation +[Debian]: https://packages.debian.org/testing/neovim +[Ubuntu]: http://packages.ubuntu.com/search?keywords=neovim +[Fedora]: https://admin.fedoraproject.org/pkgdb/package/rpms/neovim +[Arch Linux]: https://www.archlinux.org/packages/?q=neovim +[Gentoo]: https://packages.gentoo.org/packages/app-editors/neovim <!-- vim: set tw=80: --> |