Skip to content

Commit

Permalink
docs: small edits
Browse files Browse the repository at this point in the history
  • Loading branch information
antoinevg committed Mar 1, 2024
1 parent d1a30fa commit 696e5ca
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 12 deletions.
3 changes: 1 addition & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,8 +50,7 @@ For more information, see:

## USBProxy 'Nouveau' and Protocol Analysis

A major new feature of the newer Facedancer codebase is the ability to man-in-the
middle USB connections -- replacing one of the authors' original [USBProxy](https://github.com/dominicgs/usbproxy)
A major new feature of the newer Facedancer codebase is the ability to MITM (Meddler-In-The-Middle) USB connections -- replacing one of the authors' original [USBProxy](https://github.com/dominicgs/usbproxy)
project. This opens up a whole new realm of applications -- including protocol analysis
and live manipulation of USB packets -- and is especially useful when you don't control
the software running on the target device (e.g. on embedded systems or games consoles).
Expand Down
14 changes: 7 additions & 7 deletions docs/source/facedancer_examples.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
===================
Facedancer examples
Facedancer Examples
===================

There are a number of :repo:`Facedancer examples<examples/>` available that demonstrate emulation of various USB device functions.
Expand All @@ -8,9 +8,9 @@ There are a number of :repo:`Facedancer examples<examples/>` available that demo
:example:`rubber-ducky.py`
--------------------------

The canonical "Hello World" of USB emulation, the rubber ducky implements a minimal subset of the USB HID class specification in order to emulate a USB keyboard.
The canonical "Hello World" of USB emulation, the rubber-ducky example implements a minimal subset of the USB HID class specification in order to emulate a USB keyboard.

.. list-table:: Compatibility
.. list-table:: Host Compatibility
:widths: 30 30 30
:header-rows: 1

Expand All @@ -26,9 +26,9 @@ The canonical "Hello World" of USB emulation, the rubber ducky implements a mini
:example:`ftdi-echo.py`
-----------------------

An emulation of an FTDI USB-to-serial converter, ``ftdi-echo`` converts input received from a connected terminal to uppercase and echoes the result back to the sender.
An emulation of an FTDI USB-to-serial converter, the ftdi-echo example converts input received from a connected terminal to uppercase and echoes the result back to the sender.

.. list-table:: Compatibility
.. list-table:: Host Compatibility
:widths: 30 30 30
:header-rows: 1

Expand All @@ -44,7 +44,7 @@ An emulation of an FTDI USB-to-serial converter, ``ftdi-echo`` converts input re
:example:`mass-storage.py`
--------------------------

An emulation of a USB Mass Storage device, ``mass-storage`` can take a raw disk image file as input and present it to a target host as drive that can be mounted, read and written to.
An emulation of a USB Mass Storage device, the mass-storage example can take a raw disk image file as input and present it to a target host as drive that can be mounted, read and written to.

You can create an empty disk image for use with the emulation using:

Expand All @@ -62,7 +62,7 @@ You can also test or modify the disk image locally by mounting it with:
Remember to unmount it before using it with the device emulation!


.. list-table:: Compatibility
.. list-table:: Host Compatibility
:widths: 30 30 30
:header-rows: 1

Expand Down
6 changes: 3 additions & 3 deletions docs/source/howto_facedancer_backend.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
================================================
How to write a new Facedancer backend
================================================
=====================================
How to write a new Facedancer Backend
=====================================

Facedancer board backends can be found in the :repo:`facedancer/backends/<facedancer/backends/>` directory.

Expand Down

0 comments on commit 696e5ca

Please sign in to comment.