search

greatscottgadgets / ubertooth

Software, firmware, and hardware designs for Ubertooth
https://greatscottgadgets.com/ubertoothone/
GNU General Public License v2.0
1.95k stars 434 forks source link

Read the docs install updates #516

Open ZeroChaos- opened 1 year ago

ZeroChaos- commented 1 year ago

This page is a little confusing: https://ubertooth.readthedocs.io/en/latest/build_guide.html

There is a list of packages to install as prereqs, but then randomly there is a freebsd install section that installs everything, then there is build from source instructions right after that.

It's a bit confusing to say the least. I believe it should be reorganized to include packages at the top (most distros have packages these days) and then source building at the bottom. Additionally a note can be added to not do both source and package install, and maybe a check to run ubertooth-util before building and installing from source and causing conflicts.

straithe commented 1 year ago

Thank you for opening this issue. I would love to see a PR if you are interested in updating these docs.