|
Name |
|
Date |
Size |
#Lines |
LOC |
| .. | | 03-May-2022 | - |
| ci/ | H | 31-Dec-2021 | - | 1,255 | 970 |
| cmake/ | H | 31-Dec-2021 | - | 1,436 | 1,222 |
| config/ | H | 03-May-2022 | - | 99 | 81 |
| contrib/ | H | 31-Dec-2021 | - | 2,345 | 1,925 |
| man/ | H | 31-Dec-2021 | - | 400 | 397 |
| runtime/ | H | 03-May-2022 | - | 248,731 | 215,240 |
| scripts/ | H | 31-Dec-2021 | - | 5,645 | 4,214 |
| snap/ | H | 31-Dec-2021 | - | 90 | 84 |
| src/ | H | 31-Dec-2021 | - | 643,619 | 487,081 |
| test/ | H | 31-Dec-2021 | - | 141,484 | 123,873 |
| third-party/ | H | 03-May-2022 | - | 1,713 | 1,521 |
| unicode/ | H | 03-May-2022 | - | | |
| .clang-format | H A D | 31-Dec-2021 | 556 | 21 | 20 |
| .clangd | H A D | 31-Dec-2021 | 102 | 3 | 2 |
| .editorconfig | H A D | 31-Dec-2021 | 208 | 14 | 11 |
| .flake8 | H A D | 31-Dec-2021 | 30 | 3 | 2 |
| .git-blame-ignore-revs | H A D | 31-Dec-2021 | 1.4 KiB | 39 | 35 |
| .gitattributes | H A D | 31-Dec-2021 | 154 | 7 | 6 |
| .gitignore | H A D | 31-Dec-2021 | 1.1 KiB | 74 | 60 |
| .luacheckrc | H A D | 31-Dec-2021 | 672 | 32 | 24 |
| .luacov | H A D | 31-Dec-2021 | 477 | 23 | 18 |
| BACKERS.md | H A D | 31-Dec-2021 | 14.6 KiB | 647 | 639 |
| BSDmakefile | H A D | 31-Dec-2021 | 109 | 5 | 4 |
| CONTRIBUTING.md | H A D | 31-Dec-2021 | 12 KiB | 291 | 235 |
| LICENSE | H A D | 31-Dec-2021 | 15.6 KiB | 291 | 249 |
| MAINTAIN.md | H A D | 31-Dec-2021 | 3.5 KiB | 93 | 71 |
| Makefile | H A D | 31-Dec-2021 | 6.8 KiB | 230 | 162 |
| README.md | H A D | 31-Dec-2021 | 6 KiB | 129 | 97 |
README.md
1[![Neovim](https://raw.githubusercontent.com/neovim/neovim.github.io/master/logos/neovim-logo-300x87.png)](https://neovim.io)
2
3[Documentation](https://neovim.io/doc/general/) |
4[Chat](https://app.element.io/#/room/#neovim:matrix.org) |
5[Twitter](https://twitter.com/Neovim)
6
7[![GitHub CI](https://github.com/neovim/neovim/workflows/CI/badge.svg)](https://github.com/neovim/neovim/actions?query=workflow%3ACI+branch%3Amaster+event%3Apush)
8[![Codecov coverage](https://img.shields.io/codecov/c/github/neovim/neovim.svg)](https://codecov.io/gh/neovim/neovim)
9[![Coverity Scan analysis](https://scan.coverity.com/projects/2227/badge.svg)](https://scan.coverity.com/projects/2227)
10[![Clang analysis](https://neovim.io/doc/reports/clang/badge.svg)](https://neovim.io/doc/reports/clang)
11[![PVS-Studio analysis](https://neovim.io/doc/reports/pvs/badge.svg)](https://neovim.io/doc/reports/pvs/PVS-studio.html.d)
12
13[![Packages](https://repology.org/badge/tiny-repos/neovim.svg)](https://repology.org/metapackage/neovim)
14[![Debian CI](https://badges.debian.net/badges/debian/testing/neovim/version.svg)](https://buildd.debian.org/neovim)
15[![Downloads](https://img.shields.io/github/downloads/neovim/neovim/total.svg?maxAge=2592001)](https://github.com/neovim/neovim/releases/)
16[![nvim](https://snapcraft.io//nvim/badge.svg)](https://snapcraft.io/nvim)
17
18Neovim is a project that seeks to aggressively refactor Vim in order to:
19
20- Simplify maintenance and encourage [contributions](CONTRIBUTING.md)
21- Split the work between multiple developers
22- Enable [advanced UIs] without modifications to the core
23- Maximize [extensibility](https://github.com/neovim/neovim/wiki/Plugin-UI-architecture)
24
25See the [Introduction](https://github.com/neovim/neovim/wiki/Introduction) wiki page and [Roadmap]
26for more information.
27
28Features
29--------
30
31- Modern [GUIs](https://github.com/neovim/neovim/wiki/Related-projects#gui)
32- [API access](https://github.com/neovim/neovim/wiki/Related-projects#api-clients)
33 from any language including C/C++, C#, Clojure, D, Elixir, Go, Haskell, Java,
34 JavaScript/Node.js, Julia, Lisp, Lua, Perl, Python, Racket, Ruby, Rust
35- Embedded, scriptable [terminal emulator](https://neovim.io/doc/user/nvim_terminal_emulator.html)
36- Asynchronous [job control](https://github.com/neovim/neovim/pull/2247)
37- [Shared data (shada)](https://github.com/neovim/neovim/pull/2506) among multiple editor instances
38- [XDG base directories](https://github.com/neovim/neovim/pull/3470) support
39- Compatible with most Vim plugins, including Ruby and Python plugins
40
41See [`:help nvim-features`][nvim-features] for the full list!
42
43Install from package
44--------------------
45
46Pre-built packages for Windows, macOS, and Linux are found on the
47[Releases](https://github.com/neovim/neovim/releases/) page.
48
49[Managed packages] are in [Homebrew], [Debian], [Ubuntu], [Fedora], [Arch Linux], [Void Linux], [Gentoo], and more!
50
51Install from source
52-------------------
53
54See the [Building Neovim](https://github.com/neovim/neovim/wiki/Building-Neovim) wiki page for details.
55
56The build is CMake-based, but a Makefile is provided as a convenience.
57After installing the dependencies, run the following command.
58
59 make CMAKE_BUILD_TYPE=RelWithDebInfo
60 sudo make install
61
62To install to a non-default location:
63
64 make CMAKE_INSTALL_PREFIX=/full/path/
65 make install
66
67CMake hints for inspecting the build:
68
69- `cmake --build build --target help` lists all build targets.
70- `build/CMakeCache.txt` (or `cmake -LAH build/`) contains the resolved values of all CMake variables.
71- `build/compile_commands.json` shows the full compiler invocations for each translation unit.
72
73Transitioning from Vim
74--------------------
75
76See [`:help nvim-from-vim`](https://neovim.io/doc/user/nvim.html#nvim-from-vim) for instructions.
77
78Project layout
79--------------
80
81 ├─ ci/ build automation
82 ├─ cmake/ build scripts
83 ├─ runtime/ user plugins/docs
84 ├─ src/nvim/ application source code (see src/nvim/README.md)
85 │ ├─ api/ API subsystem
86 │ ├─ eval/ VimL subsystem
87 │ ├─ event/ event-loop subsystem
88 │ ├─ generators/ code generation (pre-compilation)
89 │ ├─ lib/ generic data structures
90 │ ├─ lua/ Lua subsystem
91 │ ├─ msgpack_rpc/ RPC subsystem
92 │ ├─ os/ low-level platform code
93 │ └─ tui/ built-in UI
94 ├─ third-party/ CMake subproject to build dependencies
95 └─ test/ tests (see test/README.md)
96
97License
98-------
99
100Neovim contributions since [b17d96][license-commit] are licensed under the
101Apache 2.0 license, except for contributions copied from Vim (identified by the
102`vim-patch` token). See LICENSE for details.
103
104 Vim is Charityware. You can use and copy it as much as you like, but you are
105 encouraged to make a donation for needy children in Uganda. Please see the
106 kcc section of the vim docs or visit the ICCF web site, available at these URLs:
107
108 http://iccf-holland.org/
109 http://www.vim.org/iccf/
110 http://www.iccf.nl/
111
112 You can also sponsor the development of Vim. Vim sponsors can vote for
113 features. The money goes to Uganda anyway.
114
115[license-commit]: https://github.com/neovim/neovim/commit/b17d9691a24099c9210289f16afb1a498a89d803
116[nvim-features]: https://neovim.io/doc/user/vim_diff.html#nvim-features
117[Roadmap]: https://neovim.io/roadmap/
118[advanced UIs]: https://github.com/neovim/neovim/wiki/Related-projects#gui
119[Managed packages]: https://github.com/neovim/neovim/wiki/Installing-Neovim#install-from-package
120[Debian]: https://packages.debian.org/testing/neovim
121[Ubuntu]: http://packages.ubuntu.com/search?keywords=neovim
122[Fedora]: https://apps.fedoraproject.org/packages/neovim
123[Arch Linux]: https://www.archlinux.org/packages/?q=neovim
124[Void Linux]: https://voidlinux.org/packages/?arch=x86_64&q=neovim
125[Gentoo]: https://packages.gentoo.org/packages/app-editors/neovim
126[Homebrew]: https://formulae.brew.sh/formula/neovim
127
128<!-- vim: set tw=80: -->
129