diff --git a/README.md b/README.md index 094a3070..8a63d3d2 100644 --- a/README.md +++ b/README.md @@ -6,6 +6,30 @@ YouCompleteMe: a code-completion engine for Vim [![Build status](https://ci.appveyor.com/api/projects/status/ag9uqwi8s6btwjd8/branch/master?svg=true)](https://ci.appveyor.com/project/Valloric/YouCompleteMe) [![Coverage Status](https://codecov.io/gh/Valloric/YouCompleteMe/branch/master/graph/badge.svg)](https://codecov.io/gh/Valloric/YouCompleteMe) +Help, Advice, Support +--------------------- + +Looking for help, advice or support? Having problems getting YCM to work? + +First carefully read the [installation instructions](#installation) for your OS. +We recommend you use the supplied `install.py`. + +Next check the [User Guide](#user-guide) section on the semantic completer that +you are using. For C/C++/Objective C, you _must_ read +[this section](#c-family-semantic-completion). + +Finally, check the [FAQ](#faq). + +If, after reading the installation and user guides, and checking the FAQ, you're +still having trouble, check the [contacts](#contact) section below for how to +get in touch. + +Please do **NOT** go to #vim on freenode for support. Please contact the +YouCompleteMe maintainers directly using the [contact details](#contact) below. + +Contents +-------- + - [Intro](#intro) - [Installation](#installation) - [Mac OS X](#mac-os-x) @@ -42,6 +66,7 @@ YouCompleteMe: a code-completion engine for Vim - [Contact](#contact) - [License](#license) + Intro ----- @@ -3076,13 +3101,17 @@ If you have questions about the plugin or need help, please join the [Gitter room][gitter] or use the [ycm-users][] mailing list. If you have bug reports or feature suggestions, please use the [issue -tracker][tracker]. +tracker][tracker]. Before you do, please carefully read +[CONTRIBUTING.md][contributing-md] as this asks for important diagnostics which +the team will use to help get you going. The latest version of the plugin is available at . The author's homepage is . +Please do **NOT** go to #vim on freenode for support. Please contact the +YouCompleteMe maintainers directly using the [contact details](#contact) below. License ------- @@ -3158,3 +3187,4 @@ This software is licensed under the [GPL v3 license][gpl]. [vim-nerdtree-tabs]: https://github.com/jistr/vim-nerdtree-tabs [++enc]: http://vimdoc.sourceforge.net/htmldoc/editing.html#++enc [rustup]: https://www.rustup.rs/ +[contributing-md]: https://github.com/Valloric/YouCompleteMe/blob/master/CONTRIBUTING.md