Skip to content

Commit

Permalink
add supported platforms table in readme document
Browse files Browse the repository at this point in the history
  • Loading branch information
rhysd committed Feb 1, 2025
1 parent c0ea793 commit 2a41a50
Showing 1 changed file with 18 additions and 3 deletions.
21 changes: 18 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ Install the latest nightly Vim:
```
Install the latest Vim v8.1.123. The version is a tag name in [vim/vim][vim] repository. Please see
the following 'Choose specific version' section as well:
the following 'Choosing a specific version' section as well:
```yaml
- uses: rhysd/action-setup-vim@v1
Expand Down Expand Up @@ -81,7 +81,7 @@ Install the latest nightly Neovim:
version: nightly
```

Install the Neovim v0.4.3. Please see the following 'Choose specific version' section as well:
Install the Neovim v0.4.3. Please see the following 'Choosing a specific version' section as well:

```yaml
- uses: rhysd/action-setup-vim@v1
Expand Down Expand Up @@ -178,7 +178,7 @@ cause 'Asset Not Found' error. This is because the Nightly build failed due to s
[neovim/neovim][neovim] CI workflow. In the case, this action tries to build Neovim from sources on
Linux and macOS workers. It gives up installation on other platforms.

## Choose specific version
## Choosing a specific version

### Vim

Expand All @@ -199,6 +199,21 @@ versions have release assets. For example,
[Neovim 0.4.0](https://github.com/neovim/neovim/releases/tag/v0.4.0) has no Windows releases so it
is not available for installing Neovim on Windows.

## Supported platforms

| | Vim | Neovim |
|---------------------------|-----------------------------|-------------------------|
| Linux x86_64 | :white_check_mark: | :white_check_mark: |
| Linux arm64 | :white_check_mark: | :warning: since v0.10.4 |
| Linux arm32 (self-hosted) | :white_check_mark: | :x: |
| Windows x86_64 | :warning: no stable version | :white_check_mark: |
| macOS x86_64 | :white_check_mark: | :white_check_mark: |
| macOS arm64 | :white_check_mark: | :white_check_mark: |

- :white_check_mark: : Supported
- :warning: : Supported with limitation
- :x: : Unsupported

## Current limitation

- GUI version (gVim and nvim-qt) is supported partially as described in above section.
Expand Down

0 comments on commit 2a41a50

Please sign in to comment.