aboutsummaryrefslogtreecommitdiff
path: root/runtime/doc/support.txt
diff options
context:
space:
mode:
authorJosh Rahm <joshuarahm@gmail.com>2023-01-25 18:31:31 +0000
committerJosh Rahm <joshuarahm@gmail.com>2023-01-25 18:31:31 +0000
commit9243becbedbb6a1592208051f8fa2b090dcc5e7d (patch)
tree607c2a862ec3f4399b8766383f6f8e04c4aa43b4 /runtime/doc/support.txt
parent9e40b6e9e1bc67f2d856adb837ee64dd0e25b717 (diff)
parent3c48d3c83fc21dbc0841f9210f04bdb073d73cd1 (diff)
downloadrneovim-usermarks.tar.gz
rneovim-usermarks.tar.bz2
rneovim-usermarks.zip
Merge remote-tracking branch 'upstream/master' into usermarksusermarks
Diffstat (limited to 'runtime/doc/support.txt')
-rw-r--r--runtime/doc/support.txt52
1 files changed, 52 insertions, 0 deletions
diff --git a/runtime/doc/support.txt b/runtime/doc/support.txt
new file mode 100644
index 0000000000..481959d8f1
--- /dev/null
+++ b/runtime/doc/support.txt
@@ -0,0 +1,52 @@
+*support.txt* Nvim
+
+
+ NVIM REFERENCE MANUAL
+
+
+Support *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 22.04
+macOS (Intel) 1 >= 10.15 macOS 12
+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: