mirror of
https://github.com/neovim/neovim.git
synced 2024-09-17 20:58:20 -04:00
docs: "supported platforms" matrix #19615
Inspired by libuv's own SUPPORTED_PLATFORMS.md: https://github.com/libuv/libuv/blob/v1.x/ https://neovim.io/doc/user/support.html
This commit is contained in:
parent
8f31a730c0
commit
8617101b6b
@ -53,7 +53,7 @@ Pre-built packages for Windows, macOS, and Linux are found on the
|
|||||||
Install from source
|
Install from source
|
||||||
-------------------
|
-------------------
|
||||||
|
|
||||||
See the [Building Neovim](https://github.com/neovim/neovim/wiki/Building-Neovim) wiki page for details.
|
See the [Building Neovim](https://github.com/neovim/neovim/wiki/Building-Neovim) wiki page and [supported platforms](https://neovim.io/doc/user/support.html#supported-platforms) for details.
|
||||||
|
|
||||||
The build is CMake-based, but a Makefile is provided as a convenience.
|
The build is CMake-based, but a Makefile is provided as a convenience.
|
||||||
After installing the dependencies, run the following command.
|
After installing the dependencies, run the following command.
|
||||||
|
@ -179,6 +179,7 @@ Versions ~
|
|||||||
|deprecated.txt| Deprecated items that have been or will be removed
|
|deprecated.txt| Deprecated items that have been or will be removed
|
||||||
|
|
||||||
Other ~
|
Other ~
|
||||||
|
|news.txt| News and notable changes in the latest release
|
||||||
|terminal_emulator.txt| Terminal buffers
|
|terminal_emulator.txt| Terminal buffers
|
||||||
|term.txt| Terminal UI
|
|term.txt| Terminal UI
|
||||||
|ui.txt| Nvim UI protocol
|
|ui.txt| Nvim UI protocol
|
||||||
@ -187,6 +188,7 @@ Other ~
|
|||||||
|job_control.txt| Spawn and control multiple processes
|
|job_control.txt| Spawn and control multiple processes
|
||||||
|luaref.txt| Lua reference manual
|
|luaref.txt| Lua reference manual
|
||||||
|luvref.txt| Luv (|vim.loop|) reference manual
|
|luvref.txt| Luv (|vim.loop|) reference manual
|
||||||
|
|support.txt| Supported platforms
|
||||||
|
|
||||||
*standard-plugin-list*
|
*standard-plugin-list*
|
||||||
Standard plugins ~
|
Standard plugins ~
|
||||||
|
52
runtime/doc/support.txt
Normal file
52
runtime/doc/support.txt
Normal file
@ -0,0 +1,52 @@
|
|||||||
|
*support.txt* Nvim
|
||||||
|
|
||||||
|
|
||||||
|
NVIM REFERENCE MANUAL
|
||||||
|
|
||||||
|
|
||||||
|
Support
|
||||||
|
|
||||||
|
Type |gO| to see the table of contents.
|
||||||
|
|
||||||
|
==============================================================================
|
||||||
|
Supported platforms *supported-platforms*
|
||||||
|
|
||||||
|
`System` `Tier` `Versions` `Tested versions`
|
||||||
|
Linux 1 >= 2.6.32, glibc >= 2.12 Ubuntu 20.04
|
||||||
|
macOS (Intel) 1 >= 10.15 macOS 11
|
||||||
|
Windows 64-bit 1 >= 8 Windows Server 2019
|
||||||
|
FreeBSD 1 >= 10 FreeBSD 13
|
||||||
|
macOS (M1) 2 >= 10.15
|
||||||
|
OpenBSD 2 >= 7
|
||||||
|
MinGW 2 MinGW-w64
|
||||||
|
|
||||||
|
Support types ~
|
||||||
|
|
||||||
|
* Tier 1: Officially supported and tested with CI. Any contributed patch
|
||||||
|
MUST NOT break such systems.
|
||||||
|
|
||||||
|
* Tier 2: Officially supported, but not necessarily tested with CI. These
|
||||||
|
systems are maintained to the best of our ability, without being a top
|
||||||
|
priority.
|
||||||
|
|
||||||
|
* Tier 3: Not tested and no guarantees, but may work.
|
||||||
|
|
||||||
|
Adding support for a new platform ~
|
||||||
|
|
||||||
|
IMPORTANT: Before attempting to add support for a new platform please open
|
||||||
|
an issue about it for discussion.
|
||||||
|
|
||||||
|
|
||||||
|
==============================================================================
|
||||||
|
Common
|
||||||
|
|
||||||
|
Some common notes when adding support for new platforms:
|
||||||
|
|
||||||
|
Cmake is the only supported build system. The platform must be buildable with cmake.
|
||||||
|
|
||||||
|
All functionality related to the new platform must be implemented in its own
|
||||||
|
file inside `src/nvim/os` unless it's already done in a common file, in which
|
||||||
|
case adding an `#ifdef` is fine.
|
||||||
|
|
||||||
|
|
||||||
|
vim:tw=78:ts=8:et:ft=help:norl:
|
Loading…
Reference in New Issue
Block a user