search

arkq / bluez-alsa

Bluetooth Audio ALSA Backend
MIT License
864 stars 189 forks source link

Introduce troubleshooting guide #630

Closed borine closed 1 year ago

borine commented 1 year ago

Perhaps troubleshooting tips would be better placed in a separate file? I thought I'd try it just to see what other people think. I've made each item a heading, so that each can be directly linked, e.g. when commenting on issues.

codecov[bot] commented 1 year ago

Codecov Report

Patch coverage has no change and project coverage change: +0.05 :tada:

Comparison is base (9c43684) 69.84% compared to head (5327d28) 69.90%.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## master #630 +/- ## ========================================== + Coverage 69.84% 69.90% +0.05% ========================================== Files 48 48 Lines 8921 8918 -3 ========================================== + Hits 6231 6234 +3 + Misses 2690 2684 -6 ``` [see 7 files with indirect coverage changes](https://app.codecov.io/gh/Arkq/bluez-alsa/pull/630/indirect-changes?src=pr&el=tree-more&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=Arkadiusz+Bokowy)

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Do you have feedback about the report comment? Let us know in this issue.

arkq commented 1 year ago

And one more thought. Maybe we should add a hint about TROUBLESHOOTING.md at the beginning of the bug report issue template?

borine commented 1 year ago

Maybe we should add a hint about TROUBLESHOOTING.md at the beginning of the bug report

I've added a link to the troubleshooting guide to the template, and extended the guide with issue reporting hints. Also added an INSTALL.md section on manually setting up the runtime environment.