diff options
author | pgen <p.gen.progs@gmail.com> | 2020-12-21 23:59:19 +0100 |
---|---|---|
committer | pgen <p.gen.progs@gmail.com> | 2020-12-22 00:17:57 +0100 |
commit | 5f82c35e30a9f477c1ff3dd59b7e609a51a0a59e (patch) | |
tree | baa70414f7fb5631047b43e5056e17da397bb2d7 /README.rst | |
parent | 6e2417e3b26160fd4902a0ecbadc99e7a347218a (diff) |
Improve readme
Clarify the choice between opening an issue or a discussion.
Diffstat (limited to 'README.rst')
-rw-r--r-- | README.rst | 24 |
1 files changed, 23 insertions, 1 deletions
@@ -17,7 +17,7 @@ database. Please use the included man page to learn more about this little program. -The wiki (https://github.com/p-gen/smenu/wiki) contains screenshots and +The `wiki <https://github.com/p-gen/smenu/wiki>`_ contains screenshots and animations that detail some concepts and features of **smenu**. How to build it? @@ -39,6 +39,28 @@ How to install it? Once the build process has finished, a simple ``make install`` with the appropriate privileges will do it. +Issue vs Discussion. +==================== +I have enabled `discussions <https://github.com/p-gen/smenu/discussions>`_ +on this repository. + +I am aware there may be some confusion when deciding where you should +communicate when reporting issues, asking questions or raising feature +requests so this section aims to help us align on that. + +Please `raise an issue <https://github.com/p-gen/smenu/issues>`_ if: + +- You have found a bug. +- You have a feature request and can clearly describe your request. + +Please `open a discussion <https://github.com/p-gen/smenu/discussions>`_ if: + +- You have a question. +- You're not sure how to achieve something with smenu. +- You have an idea but don't quite know how you would like it to work. +- You have achieved something cool with smenu and want to show it off. +- Anything else! + Some examples. ============== |