mirror of
https://github.com/neovim/neovim.git
synced 2026-04-22 15:25:30 +00:00
68e0b1bd01
Content: * Refer to the formatter as "GNU troff". Strictly, "groff" refers to several things.[1] Since the context is the editing of input to the formatter, GNU's troff program is most relevant choice. * Refer to groff as distributions' default "typesetting" rather than "text processing" package. Many text processing tools exist, and some distributions (Alpine Linux, NetBSD, OpenBSD) have replaced groff with mandoc[2] as their man page formatter. * Mention that Plan 9 still ships an AT&T-derived troff; they even maintain it.[3] * Correct explanation of traditional `yr` register (1). `\n(yr` is not a request, but an escape sequence.[4] * Correct explanation of traditional `yr` register (2). This register has not interpolated a "2-digit year" since the year 2000; it now interpolates a 3-digit one, because AT&T troff designed the `yr` register with a Y2K bug in it.[5] * Fix scrambled terminology. The phrase "macro request" confuses two separate things: macros and requests.[6] Say instead "font, request, register, macro, and string names"; these are the formatter object types that people writing groff documents most often use. * Refer to "groff's mm package" instead of "GNU mm". Strictly, this package is in groff's "contrib" area, which implies that it's not official GNU product. (To be fair, after shipping with groff for over 34 years,[7] I'm not sure how much distinction anyone perceives.) * Motivate the newly added advice preferring macro package facilities for paragraphing; this issue is distinct from aiding sentence boundary detection, which until recently[8] was the only advice offered here. Style: * Condense introductory paragraphs. * Refer to "language syntax" rather than "language primitives". * Use slightly more idiomatic English. While these revisions convey more information, they leave the line count unchanged. I'll try to stop fooling with this material now. Notes: [1] https://cgit.git.savannah.gnu.org/cgit/groff.git/tree/man/groff.7.man?h=1.24.0.rc1#n303 [2] https://mandoc.bsd.lv/ [3] https://github.com/9fans/plan9port/pull/7384f3a4d8b3d[4] https://www.gnu.org/software/groff/manual/groff.html.node/Formatter-Instructions.html https://github.com/mamccollum/troff-resources/blob/main/cstr-54.pdf [5] Tellingly, groff added the `year` register in its 1.16 release, dated 2000-05-23. https://cgit.git.savannah.gnu.org/cgit/groff.git/tree/NEWS?h=1.24.0.rc1#n3650 https://cgit.git.savannah.gnu.org/cgit/groff.git/tree/ChangeLog.116?h=1.24.0.rc1#n261 [6] https://www.gnu.org/software/groff/manual/groff.html.node/Requests-and-Macros.html https://www.gnu.org/software/groff/manual/groff.html.node/groff.html_fot.html#FOOT26 [7] https://cgit.git.savannah.gnu.org/cgit/groff.git/tree/NEWS?h=1.24.0.rc1#n4192 https://cgit.git.savannah.gnu.org/cgit/groff.git/tree/ChangeLog.old?h=1.24.0.rc1#n2714 [8]638bbc57c1closes: vim/vim#19221f338a2f1a6Co-authored-by: G. Branden Robinson <g.branden.robinson@gmail.com>
Neovim is a project that seeks to aggressively refactor Vim in order to:
- Simplify maintenance and encourage contributions
- Split the work between multiple developers
- Enable advanced UIs without modifications to the core
- Maximize extensibility
See the Introduction wiki page and Roadmap for more information.
Features
- Modern GUIs
- API access from any language including C/C++, C#, Clojure, D, Elixir, Go, Haskell, Java/Kotlin, JavaScript/Node.js, Julia, Lisp, Lua, Perl, Python, Racket, Ruby, Rust
- Embedded, scriptable terminal emulator
- Asynchronous job control
- Shared data (shada) among multiple editor instances
- XDG base directories support
- Compatible with most Vim plugins, including Ruby and Python plugins
See :help nvim-features for the full list, and :help news for noteworthy changes in the latest version!
Install from package
Pre-built packages for Windows, macOS, and Linux are found on the Releases page.
Managed packages are in Homebrew, Debian, Ubuntu, Fedora, Arch Linux, Void Linux, Gentoo, and more!
Install from source
See BUILD.md and supported platforms for details.
The build is CMake-based, but a Makefile is provided as a convenience. After installing the dependencies, run the following command.
make CMAKE_BUILD_TYPE=RelWithDebInfo
sudo make install
To install to a non-default location:
make CMAKE_BUILD_TYPE=RelWithDebInfo CMAKE_INSTALL_PREFIX=/full/path/
make install
CMake hints for inspecting the build:
cmake --build build --target helplists all build targets.build/CMakeCache.txt(orcmake -LAH build/) contains the resolved values of all CMake variables.build/compile_commands.jsonshows the full compiler invocations for each translation unit.
Transitioning from Vim
See :help nvim-from-vim for instructions.
Project layout
├─ cmake/ CMake utils
├─ cmake.config/ CMake defines
├─ cmake.deps/ subproject to fetch and build dependencies (optional)
├─ runtime/ plugins and docs
├─ src/nvim/ application source code (see src/nvim/README.md)
│ ├─ api/ API subsystem
│ ├─ eval/ Vimscript 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
└─ test/ tests (see test/README.md)
License
Neovim contributions since b17d96 are licensed under the
Apache 2.0 license, except for contributions copied from Vim (identified by the
vim-patch token). See LICENSE.txt for details.