From e39c1ee5b3f572829bdd50b26fb6a809dda971ef Mon Sep 17 00:00:00 2001 From: rhysd Date: Tue, 14 Apr 2020 01:23:34 +0900 Subject: [PATCH] add known issues section to document (#57) --- README.md | 6 +++++- doc/git-messenger.txt | 10 ++++++++++ 2 files changed, 15 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 5d03cbb..718512a 100644 --- a/README.md +++ b/README.md @@ -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 @@ -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/ diff --git a/doc/git-messenger.txt b/doc/git-messenger.txt index 89c0c26..febcb68 100644 --- a/doc/git-messenger.txt +++ b/doc/git-messenger.txt @@ -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| @@ -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*