Add SUPPORT.md (#803)

Adding this file to the root of the project will make a note appear when
opening a new issue, asking the user to first read this document.

As proposed in #802
This commit is contained in:
Patrick Ziegler 2017-10-28 23:17:46 +02:00 committed by GitHub
parent 83610461f9
commit a3e9bb9847
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 10 additions and 0 deletions

View File

@ -14,6 +14,8 @@ Here are a few screenshots showing you what it can look like:
[![sample screenshot](http://i.imgur.com/A6spiZZt.png)](http://i.imgur.com/A6spiZZ.png) [![sample screenshot](http://i.imgur.com/A6spiZZt.png)](http://i.imgur.com/A6spiZZ.png)
[![sample screenshot](http://i.imgur.com/TY5a5r9t.png)](http://i.imgur.com/TY5a5r9.png) [![sample screenshot](http://i.imgur.com/TY5a5r9t.png)](http://i.imgur.com/TY5a5r9.png)
If you need help, check out the [Support](SUPPORT.md) page.
Please report any issues or bugs you may find by [creating an issue ticket](https://github.com/jaagr/polybar/issues/new) here on GitHub. Please report any issues or bugs you may find by [creating an issue ticket](https://github.com/jaagr/polybar/issues/new) here on GitHub.
Make sure you include steps on how to reproduce it. There's also an irc channel available at freenode, cleverly named `#polybar`. Make sure you include steps on how to reproduce it. There's also an irc channel available at freenode, cleverly named `#polybar`.

8
SUPPORT.md Normal file
View File

@ -0,0 +1,8 @@
Polybar Support
===============
Reading [Polybar Wiki](https://github.com/jaagr/polybar/wiki) should help you with most of the problems you encounter when using polybar. It has a page for each module, describing what it does and what configuration options it provides.
If you can't find the information you are looking for on the wiki, look through the existing [issues](https://github.com/jaagr/polybar/issues?q=is%3Aissue), to see if anyone had the same problem before.
If you are still not able to resolve your problem, go ahead and open a new issue and also document what you have done up to that point to solve the problem.