Auto merge of #2866 - puremourning:readme-contacts, r=micbou

[READY] Signpost the contact details earlier in the README

# PR Prelude

Thank you for working on YCM! :)

**Please complete these steps and check these boxes (by putting an `x` inside
the brackets) _before_ filing your PR:**

- [x] I have read and understood YCM's [CONTRIBUTING][cont] document.
- [x] I have read and understood YCM's [CODE_OF_CONDUCT][code] document.
- [x] I have included tests for the changes in my PR. If not, I have included a
  rationale for why I haven't.
- [x] **I understand my PR may be closed if it becomes obvious I didn't
  actually perform all of these steps.**

# Why this change is necessary and useful

At the request of the nice folk over at `#vim` on free node, this PR signposts the contact details and installation instructions at the top of the readme so that users seeking help use our contact details, rather than asking over there.

Overall it is better for users to seek support from us because:

* we have better knowledge and can solve issues more quickly
* we get better visibility of in-the-wild issues and sticking points
* certain #vim users feel that they are unduly burdened with supporting setup issues for YCM

cc @romainl

[cont]: https://github.com/Valloric/YouCompleteMe/blob/master/CONTRIBUTING.md
[code]: https://github.com/Valloric/YouCompleteMe/blob/master/CODE_OF_CONDUCT.md

<!-- Reviewable:start -->
---
This change is [<img src="https://reviewable.io/review_button.svg" height="34" align="absmiddle" alt="Reviewable"/>](https://reviewable.io/reviews/valloric/youcompleteme/2866)
<!-- Reviewable:end -->
This commit is contained in:
zzbot 2017-12-31 15:46:03 -08:00 committed by GitHub
commit ad41dfb8af

View File

@ -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
<http://valloric.github.io/YouCompleteMe/>.
The author's homepage is <http://val.markovic.io>.
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