From 9a31a24a25105354e65931d637a9f51989c34edd Mon Sep 17 00:00:00 2001 From: jdhao Date: Sun, 25 Jul 2021 16:44:16 +0800 Subject: [PATCH] update readme --- README.md | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index a017697..1a1a413 100644 --- a/README.md +++ b/README.md @@ -4,10 +4,10 @@ # Introduction -This is my Neovim configuration for all the platforms I use (Linux, Windows and -macOS). `init.vim` is the config file for terminal Neovim, and `ginit.vim` is -the additional config file for GUI client of Neovim (I am using -[neovim-qt](https://github.com/equalsraf/neovim-qt) for now on Windows). +This repo hosts my Nvim configuration for all the platforms I am using (Linux, +Windows and macOS). `init.vim` is the config entrypoint for terminal Neovim, +and `ginit.vim` is the additional config file for GUI client of Neovim (I am +using [neovim-qt](https://github.com/equalsraf/neovim-qt) for now on Windows). My configurations are heavily documented to make it as clear as possible. While you can download the whole repository and use it, it is not recommended though. @@ -18,6 +18,9 @@ add it to your own Nvim config. See [doc here](docs/README.md) on how to install Nvim's dependencies, Nvim itself, and how to set up on different platforms (Linux, macOS and Windows). +**This config is always tested against the latest nvim master release. No +backward compatibility is guaranteed.** + # Features # + Plugin management via [Packer.nvim](https://github.com/wbthomason/packer.nvim).