minor updates

This commit is contained in:
rUv
2025-06-07 17:11:45 +00:00
parent fe5e3d1915
commit 078c5d8957
17 changed files with 745 additions and 105 deletions

123
README.md
View File

@@ -24,60 +24,75 @@ A cutting-edge WiFi-based human pose estimation system that leverages Channel St
## 📋 Table of Contents
1. [🚀 Key Features](#-key-features)
2. [🏗️ System Architecture](#-system-architecture)
- [Core Components](#core-components)
3. [📦 Installation](#-installation)
- [Using pip (Recommended)](#using-pip-recommended)
- [From Source](#from-source)
- [Using Docker](#using-docker)
- [System Requirements](#system-requirements)
4. [🚀 Quick Start](#-quick-start)
- [Basic Setup](#1-basic-setup)
- [Start the System](#2-start-the-system)
- [Using the REST API](#3-using-the-rest-api)
- [Real-time Streaming](#4-real-time-streaming)
5. [🖥️ CLI Usage](#-cli-usage)
- [Installation](#cli-installation)
- [Basic Commands](#basic-commands)
- [Configuration Commands](#configuration-commands)
- [Monitoring Commands](#monitoring-commands)
- [Examples](#cli-examples)
6. [📚 Documentation](#-documentation)
- [Core Documentation](#-core-documentation)
- [Quick Links](#-quick-links)
- [API Overview](#-api-overview)
7. [🔧 Hardware Setup](#-hardware-setup)
- [Supported Hardware](#supported-hardware)
- [Physical Setup](#physical-setup)
- [Network Configuration](#network-configuration)
- [Environment Calibration](#environment-calibration)
8. [⚙️ Configuration](#-configuration)
- [Environment Variables](#environment-variables)
- [Domain-Specific Configurations](#domain-specific-configurations)
- [Advanced Configuration](#advanced-configuration)
9. [🧪 Testing](#-testing)
- [Running Tests](#running-tests)
- [Test Categories](#test-categories)
- [Mock Testing](#mock-testing)
- [Continuous Integration](#continuous-integration)
10. [🚀 Deployment](#-deployment)
- [Production Deployment](#production-deployment)
- [Infrastructure as Code](#infrastructure-as-code)
- [Monitoring and Logging](#monitoring-and-logging)
11. [📊 Performance Metrics](#-performance-metrics)
- [Benchmark Results](#benchmark-results)
- [Performance Optimization](#performance-optimization)
- [Load Testing](#load-testing)
12. [🤝 Contributing](#-contributing)
- [Development Setup](#development-setup)
- [Code Standards](#code-standards)
- [Contribution Process](#contribution-process)
- [Code Review Checklist](#code-review-checklist)
- [Issue Templates](#issue-templates)
13. [📄 License](#-license)
14. [🙏 Acknowledgments](#-acknowledgments)
15. [📞 Support](#-support)
<table>
<tr>
<td width="50%">
**🚀 Getting Started**
- [Key Features](#-key-features)
- [System Architecture](#-system-architecture)
- [Installation](#-installation)
- [Using pip (Recommended)](#using-pip-recommended)
- [From Source](#from-source)
- [Using Docker](#using-docker)
- [System Requirements](#system-requirements)
- [Quick Start](#-quick-start)
- [Basic Setup](#1-basic-setup)
- [Start the System](#2-start-the-system)
- [Using the REST API](#3-using-the-rest-api)
- [Real-time Streaming](#4-real-time-streaming)
**🖥️ Usage & Configuration**
- [CLI Usage](#-cli-usage)
- [Installation](#cli-installation)
- [Basic Commands](#basic-commands)
- [Configuration Commands](#configuration-commands)
- [Examples](#cli-examples)
- [Documentation](#-documentation)
- [Core Documentation](#-core-documentation)
- [Quick Links](#-quick-links)
- [API Overview](#-api-overview)
- [Hardware Setup](#-hardware-setup)
- [Supported Hardware](#supported-hardware)
- [Physical Setup](#physical-setup)
- [Network Configuration](#network-configuration)
- [Environment Calibration](#environment-calibration)
</td>
<td width="50%">
**⚙️ Advanced Topics**
- [Configuration](#-configuration)
- [Environment Variables](#environment-variables)
- [Domain-Specific Configurations](#domain-specific-configurations)
- [Advanced Configuration](#advanced-configuration)
- [Testing](#-testing)
- [Running Tests](#running-tests)
- [Test Categories](#test-categories)
- [Mock Testing](#mock-testing)
- [Continuous Integration](#continuous-integration)
- [Deployment](#-deployment)
- [Production Deployment](#production-deployment)
- [Infrastructure as Code](#infrastructure-as-code)
- [Monitoring and Logging](#monitoring-and-logging)
**📊 Performance & Community**
- [Performance Metrics](#-performance-metrics)
- [Benchmark Results](#benchmark-results)
- [Performance Optimization](#performance-optimization)
- [Load Testing](#load-testing)
- [Contributing](#-contributing)
- [Development Setup](#development-setup)
- [Code Standards](#code-standards)
- [Contribution Process](#contribution-process)
- [Code Review Checklist](#code-review-checklist)
- [License](#-license)
- [Acknowledgments](#-acknowledgments)
- [Support](#-support)
</td>
</tr>
</table>
## 🏗️ System Architecture