Skip to content

Latest commit

 

History

History

README.md

QUIC Test Documentation

This directory contains comprehensive documentation for the QUIC Test application and its associated tools.

Available Documentation

TUI User Guide

File: TUI_USER_GUIDE.md

Complete guide to using the QUIC Bottom Real Terminal User Interface (TUI) application. Includes:

  • Installation and setup instructions
  • Detailed description of all view modes
  • Keyboard shortcuts reference
  • Metrics interpretation guide
  • Troubleshooting section
  • Best practices

Target Audience: Users who need to interact with the TUI application for monitoring and analyzing QUIC protocol metrics.

Quick Start Guides

For quick reference on specific topics, see the main project directory:

  • BBRv3_DEMO_QUICK_START.md: Quick start for BBRv3 demonstrations
  • BBRv3_IMPLEMENTATION_TASK.md: Technical implementation details

Lecture Materials

For educational materials and lecture guides, see:

  • МЭИ_LECTURE/: Directory containing lecture materials, demo guides, and presentation outlines

Documentation Structure

docs/
├── README.md              # This file
├── TUI_USER_GUIDE.md      # Complete TUI usage guide
└── media/                 # Media files
    └── quic-thumbnail.jpg # Video thumbnail/preview

Contributing

When adding new documentation:

  1. Use Markdown format
  2. Follow the existing documentation style
  3. Include table of contents for documents longer than 50 lines
  4. Provide code examples where applicable
  5. Include troubleshooting sections for complex topics

Updates

Documentation is updated as new features are added to the application. Check the version information in each document to ensure compatibility with your installed version.