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

documentation updates #160

Merged
merged 1 commit into from
Aug 16, 2024
Merged

documentation updates #160

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 0 additions & 15 deletions docs/source/introduction.rst → docs/source/hardware/device_overview.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,21 +1,6 @@
============
Introduction
============

What is Cynthion?
-----------------

Cynthion is an all-in-one tool for building, testing, monitoring, and experimenting with USB devices. Built around a unique FPGA-based architecture, Cynthion’s digital hardware can be fully customized to suit the application at hand. As a result, it can act as a no-compromise High-Speed USB protocol analyzer, a USB-hacking multi-tool, or a USB development platform.

Out-of-the-box, Cynthion acts as a USB protocol analyzer capable of capturing and analyzing traffic between a host and any Low-, Full-, or High-Speed ("USB 2.0") USB device. It works seamlessly with our `Packetry <https://github.com/greatscottgadgets/packetry>`__ open-source analysis software.

Combined with our `LUNA <https://luna.readthedocs.io>`__ gateware and `Facedancer <https://facedancer.readthedocs.io>`__ libraries, Cynthion becomes a versatile USB-hacking and development tool. Facedancer makes it quick and easy to create or tamper with real USB devices—not just emulations—even if you don’t have experience with digital hardware design, HDL, or FPGA architecture!


Device Overview
---------------


Top View
~~~~~~~~

Expand Down
3 changes: 2 additions & 1 deletion docs/source/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Cynthion Documentation
:maxdepth: 2
:caption: User Documentation

introduction
project description
getting_started
getting_started_packetry
getting_started_facedancer
Expand All @@ -22,6 +22,7 @@ Cynthion Documentation
:caption: Cynthion Hardware

hardware/introduction
hardware/device_overview
hardware/bringup_guide
hardware/cli

Expand Down
9 changes: 9 additions & 0 deletions docs/source/project_description.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
============================
Cynthion Project Description
============================

Cynthion is an all-in-one tool for building, testing, monitoring, and experimenting with USB devices. Built around a unique FPGA-based architecture, Cynthion’s digital hardware can be fully customized to suit the application at hand. As a result, it can act as a no-compromise High-Speed USB protocol analyzer, a USB-hacking multi-tool, or a USB development platform.

Out-of-the-box, Cynthion acts as a USB protocol analyzer capable of capturing and analyzing traffic between a host and any Low-, Full-, or High-Speed ("USB 2.0") USB device. It works seamlessly with our `Packetry <https://github.com/greatscottgadgets/packetry>`__ open-source analysis software.

Combined with our `LUNA <https://luna.readthedocs.io>`__ gateware and `Facedancer <https://facedancer.readthedocs.io>`__ libraries, Cynthion becomes a versatile USB-hacking and development tool. Facedancer makes it quick and easy to create or tamper with real USB devices—not just emulations—even if you don’t have experience with digital hardware design, HDL, or FPGA architecture!
Loading