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

Include README.xxx.md information in documentation (suggestion only) #471

Open
Locutu5 opened this issue Nov 30, 2021 · 2 comments
Open
Assignees
Labels
documentation documentation improvement or addition

Comments

@Locutu5
Copy link

Locutu5 commented Nov 30, 2021

Steps to reproduce

Can't reproduce because the information is not in the documentation

Expected behaviour

See the README.xxx.md information in the documentation instead of looking through the code.

Actual behaviour

Have to look at the README.xxx.md files in the source code to find the extra information

Version information

Operating system agnostic

Ubertooth tools version: same as Github master

libbtbb version: irrelevent

Ubertooth firmware version: same as Github master

@straithe straithe added the documentation documentation improvement or addition label Nov 30, 2021
@straithe straithe self-assigned this Nov 30, 2021
@straithe
Copy link
Member

Thank you for opening this issue. I hope to resolve it in the next two months.

@straithe
Copy link
Member

straithe commented Jul 18, 2022

I'm going to replicate the following documents into the docs folder:
host/README.md
host/README.btle.md
host/python/specan_ui/README

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation documentation improvement or addition
Projects
None yet
Development

No branches or pull requests

2 participants