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.

Sign up for GitHub

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

Jump to bottom

Update README with usage information. #2

Merged
merged 5 commits into from
Jun 11, 2021
Merged

Update README with usage information. #2

merged 5 commits into from
Jun 11, 2021

Conversation

abeltrano
Copy link
Contributor

@abeltrano abeltrano commented Jun 10, 2021 •
edited
Loading

Type

  • Bug fix
  • Feature addition
  • Feature update
  • Breaking change
  • Documentation

Goals

Make it easy to understand how the product works.

Technical Details

  • Describe core concepts, add examples.
  • Remove line breaks from dependency installation code.
  • Add lttng provider and event descriptions.

Test Results

  • N/A

Reviewer Focus

  • None

Future Work

  • None

Checklist

  • Build target all compiles cleanly.
  • cppcheck produces no output.
  • clang-format delta produced no new output.
  • Newly added functions include doxygen-style comment block.

@abeltrano abeltrano requested a review from a team June 10, 2021 01:43
forwardpointer
forwardpointer reviewed Jun 11, 2021
View reviewed changes
README.md Outdated

The central concept is that of a telemetry monitor, represented as
[`WifiTelemetryMonitor`](include/wifi-telemetry/wifi_telemetry_monitor.hpp).
A monitor passively tracks one or more wi-fi telemetry sources, represented as
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What does passively track mean?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The intent is to convey that we're not modifying or interacting with any of the sources that we're monitoring. We just subscribe (the tracking part) to events they already generate.

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Perhaps "subscribe" is more precise than "passively track" imo.

craiz
craiz previously approved these changes Jun 11, 2021
View reviewed changes
README.md Outdated Show resolved Hide resolved
@abeltrano abeltrano enabled auto-merge (squash) June 11, 2021 15:56
@abeltrano abeltrano added this to In progress in Wi-Fi Telemetry via automation Jun 11, 2021
@abeltrano abeltrano moved this from In progress to Review in progress in Wi-Fi Telemetry Jun 11, 2021
Wi-Fi Telemetry automation moved this from Review in progress to Reviewer approved Jun 11, 2021
@abeltrano abeltrano merged commit c95a4ad into main Jun 11, 2021
Wi-Fi Telemetry automation moved this from Reviewer approved to Done Jun 11, 2021
@abeltrano abeltrano deleted the abeltrano/readmeupdates branch June 11, 2021 17:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@forwardpointer forwardpointer forwardpointer approved these changes

@craiz craiz craiz left review comments

Assignees
No one assigned
Labels
None yet
Projects
Wi-Fi Telemetry
Done
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
3 participants
@abeltrano @craiz @forwardpointer