From a3e9bb9847271765e6e63418ca5164a576bcb42b Mon Sep 17 00:00:00 2001 From: Patrick Ziegler Date: Sat, 28 Oct 2017 23:17:46 +0200 Subject: [PATCH] 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 --- README.md | 2 ++ SUPPORT.md | 8 ++++++++ 2 files changed, 10 insertions(+) create mode 100644 SUPPORT.md diff --git a/README.md b/README.md index 07f7255e..15542d02 100644 --- a/README.md +++ b/README.md @@ -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/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. Make sure you include steps on how to reproduce it. There's also an irc channel available at freenode, cleverly named `#polybar`. diff --git a/SUPPORT.md b/SUPPORT.md new file mode 100644 index 00000000..538cc5b2 --- /dev/null +++ b/SUPPORT.md @@ -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.