Welcome to the usbipd-mac documentation hub. This directory contains comprehensive documentation for developers and users.
- Project README - Main project overview, installation, and basic usage
- Protocol Reference - USB/IP protocol implementation details
- QEMU Test Tool - QEMU integration testing documentation
The development/ folder contains detailed documentation for contributors:
- Architecture - System design and component overview
- CI/CD - Continuous integration and deployment workflows
- System Extension Development - macOS System Extension integration
- Testing Strategy - Testing approaches and environments
The api/ folder contains technical implementation documentation:
- USB Implementation - USB request/response protocol details
The troubleshooting/ folder contains problem resolution guides:
- Build Troubleshooting - Common build and setup issues
- QEMU Troubleshooting - QEMU testing issues
- System Extension Troubleshooting - System Extension development issues
This documentation is organized to serve different user needs:
- End Users: Start with the main README for installation and basic usage
- Contributors: Review Architecture and Testing Strategy
- Integration Developers: Reference API documentation and Protocol Reference
- Troubleshooting: Check relevant guides in the troubleshooting/ folder
For the most current information, always refer to the documentation in this folder rather than scattered documentation files throughout the codebase.