Skip to content

Commit

Permalink
add known issues section to document (#57)
Browse files Browse the repository at this point in the history
  • Loading branch information
rhysd committed Apr 13, 2020
1 parent e7ecdbb commit e39c1ee
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 1 deletion.
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -281,6 +281,10 @@ to check your environment is ready for use of this plugin.
On Vim, please install [vim-healthcheck](https://github.com/rhysd/vim-healthcheck) and run
`:CheckHealth`. It's a plugin to run `:checkhealth` on Vim.

### Known Issues

- On Windows, `git` command installed via MSYS does not work. Please use [Git for Windows][git-win]
for now. This issue is tracked at [#57](https://github.com/rhysd/git-messenger.vim/issues/57).


## License
Expand All @@ -294,4 +298,4 @@ Distributed under [the MIT License](LICENSE)
[codecov-badge]: https://codecov.io/gh/rhysd/git-messenger.vim/branch/master/graph/badge.svg
[doc]: ./doc/git-messenger.txt
[nvim-install]: https://github.com/neovim/neovim/wiki/Installing-Neovim

[git-win]: https://gitforwindows.org/
10 changes: 10 additions & 0 deletions doc/git-messenger.txt
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ Variables |git-messenger-variables|
Highlights |git-messenger-highlights|
Popup Window Config |git-messenger-popup-window-config|
Health Check |git-messenger-health-check|
Known Issues |git-messenger-known-issues|
Repository |git-messenger-repository-page|
License |git-messenger-license|

Expand Down Expand Up @@ -332,6 +333,15 @@ run `:checkhealth` on Vim.
https://github.com/rhysd/vim-healthcheck


==============================================================================
KNOWN ISSUES *git-messenger-known-issues*

1.
On Windows, `git` command installed via MSYS does not work. Please use
Git for Windows for now. This issue is tracked at
https://github.com/rhysd/git-messenger.vim/issues/57


==============================================================================
REPOSITORY *git-messenger-repository-page*

Expand Down

0 comments on commit e39c1ee

Please sign in to comment.