-
Notifications
You must be signed in to change notification settings - Fork 22
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
Add brief info to docs about what each use-case is for #177
Comments
I would also suggest adding a link to the "Getting started with packetry" doc page at the end of the "Using cynthion with pcketry" doc page, as the cynthion doc page feels like it stops part way through explaining how to use packetry. So at the bottom of the page: Add a link to one of the following: Whichever of these links you feel it is best for the reader to get directed to. Actually I think the install packetry link might be the best choice to link to |
Here is more information I think is missing:
|
Thank you for the extra documentation suggestions. We will add the extra information when we can. |
When new to cynthion it is not clear what the different uses are for.
I'd submit a pull request for this, but since I am very new to cynthion its probably best someone else writes these.
I suggest adding a brief sentence to the start of the following pages to help make it clear for new users.
docs/source/getting_started_packetry.rst
docs/source/getting_started_facedancer.rst
docs/source/getting_started_usbproxy.rst
For example on the getting_started_packetry.rst page, right at the top under the main heading, you might put a sentence like:
"This uses cynthion as a usb packet capture device between a usb host and target in order to analyze the packets sent."
The facedancer page might have something like:
"This uses cynthion to emulate usb devices"
The usb proxy page might have:
"This uses cynthion to proxy packets between another usb host and a usb target on the control machine."
The text was updated successfully, but these errors were encountered: