diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 64 |
1 files changed, 36 insertions, 28 deletions
@@ -6,12 +6,12 @@ [Community](https://neovim.io/community/) | [Gitter **Chat**](https://gitter.im/neovim/neovim) -[](https://travis-ci.org/neovim/neovim) -[](https://ci.appveyor.com/project/neovim/neovim/branch/master) -[](https://codecov.io/gh/neovim/neovim) -[](https://scan.coverity.com/projects/2227) -[](https://neovim.io/doc/reports/clang) -[](https://neovim.io/doc/reports/pvs/PVS-studio.html.d) +[](https://travis-ci.org/neovim/neovim) +[](https://ci.appveyor.com/project/neovim/neovim/branch/master) +[](https://codecov.io/gh/neovim/neovim) +[](https://scan.coverity.com/projects/2227) +[](https://neovim.io/doc/reports/clang) +[](https://neovim.io/doc/reports/pvs/PVS-studio.html.d) [](https://repology.org/metapackage/neovim) [](https://buildd.debian.org/neovim) @@ -24,11 +24,26 @@ Neovim is a project that seeks to aggressively refactor Vim in order to: - Enable [advanced UIs] without modifications to the core - Maximize [extensibility](https://github.com/neovim/neovim/wiki/Plugin-UI-architecture) -See [the wiki](https://github.com/neovim/neovim/wiki/Introduction) and [Roadmap] +See the [Introduction](https://github.com/neovim/neovim/wiki/Introduction) wiki page and [Roadmap] for more information. [](https://waffle.io/neovim/neovim/metrics) +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, and 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 +- Compatible with most Vim plugins, including Ruby and Python plugins + +See [`:help nvim-features`][nvim-features] for the full list! + Install from source ------------------- @@ -44,19 +59,27 @@ To list all targets: cmake --build build --target help -To skip "bundled" dependencies define `USE_BUNDLED_DEPS=NO` (CMake option: `USE_BUNDLED=NO`). +To skip "bundled" dependencies (`third-party/*`) define `USE_BUNDLED=NO`: + + sudo apt install gperf libluajit-5.1-dev libunibilium-dev libmsgpack-dev libtermkey-dev libvterm-dev libjemalloc-dev + make USE_BUNDLED=NO -See [the wiki](https://github.com/neovim/neovim/wiki/Building-Neovim) for details. +See the [Building Neovim](https://github.com/neovim/neovim/wiki/Building-Neovim) wiki page for details. Install from package -------------------- -Pre-built packages for Windows, macOS, and Linux are found at the +Pre-built packages for Windows, macOS, and Linux are found on 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)! +Transitioning from Vim +-------------------- + +See [`:help nvim-from-vim`](https://neovim.io/doc/user/nvim.html#nvim-from-vim) for instructions. + Project layout -------------- @@ -69,28 +92,13 @@ Project layout │ ├─ event/ event-loop subsystem │ ├─ generators/ code generation (pre-compilation) │ ├─ lib/ generic data structures - │ ├─ lua/ lua subsystem + │ ├─ lua/ Lua subsystem │ ├─ msgpack_rpc/ RPC subsystem │ ├─ os/ low-level platform code │ └─ tui/ built-in UI - ├─ third-party/ cmake subproject to build dependencies + ├─ third-party/ CMake subproject to build dependencies └─ test/ tests (see test/README.md) -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 -- Compatible with most Vim plugins, including Ruby and Python plugins. - -See [`:help nvim-features`][nvim-features] for the full list! - License ------- @@ -124,7 +132,7 @@ See `LICENSE` for details. [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 +[Fedora]: https://apps.fedoraproject.org/packages/neovim [Arch Linux]: https://www.archlinux.org/packages/?q=neovim [Gentoo]: https://packages.gentoo.org/packages/app-editors/neovim |