search

WLAN-Pi / wlanpi-profiler

Wi-Fi client capabilities analyzer tool built for the WLAN Pi
BSD 3-Clause "New" or "Revised" License
25 stars 8 forks source link

Update README.md documentation #82

Closed joshschmelzle closed 1 year ago

joshschmelzle commented 2 years ago

README.md should be updated to reflect the latest changes which include better interface handling and support for iwlwifi cards like the AX200 and AX210. Currently, the documentation only refers to mt76x2u and rtl88XXau adapters.

Additionally, for manual installation, we're still referring to pipx. For context with NEO{1,2} running WLAN Pi OS v2 images, pipx is used. Other than that, we have sunset the pipx approach for Debian packages. For development, we don't need to use pipx. Perhaps flush this out in documentation.

joshschmelzle commented 2 years ago

Need to check that v1.0.8, v1.0.8-1, and v1.0.8-2 are documented in README.md. Details in #88 #87 and also check RELEASE_NOTES.md.

joshschmelzle commented 2 years ago

The manpage file in /debian needs updated to include -f and --list_interfaces options.

joshschmelzle commented 2 years ago

Need to review #90 and update documentation accordingly.

joshschmelzle commented 2 years ago

Need to update documentation around updating profiler on legacy and future WLAN Pi platforms.

Specifically need to call out some differences between installing the Debian package which can be found on the cloud repos (Gemfury or Packagecloud) and via pipx.