Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Read the docs install updates #516

Open
ZeroChaos- opened this issue Jan 16, 2023 · 1 comment
Open

Read the docs install updates #516

ZeroChaos- opened this issue Jan 16, 2023 · 1 comment
Labels
cleanup cleanup of code, process, or documentation documentation documentation improvement or addition

Comments

@ZeroChaos-
Copy link
Contributor

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
Copy link
Member

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

@straithe straithe added cleanup cleanup of code, process, or documentation documentation documentation improvement or addition labels Jan 16, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cleanup cleanup of code, process, or documentation documentation documentation improvement or addition
Projects
None yet
Development

No branches or pull requests

2 participants