summaryrefslogtreecommitdiff
path: root/web-timeplot/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'web-timeplot/README.md')
-rw-r--r--web-timeplot/README.md49
1 files changed, 49 insertions, 0 deletions
diff --git a/web-timeplot/README.md b/web-timeplot/README.md
new file mode 100644
index 0000000..867ae7a
--- /dev/null
+++ b/web-timeplot/README.md
@@ -0,0 +1,49 @@
+# Web TimePlot - PixiJS Implementation
+
+A web-based waterfall display using PixiJS with WebGPU/WebGL support.
+
+## Features
+
+- **Dual Renderer Support**: Automatically uses WebGPU if available, falls back to WebGL
+- **Real-time Performance Metrics**: FPS, frame timing, vertex counts
+- **Interactive Controls**: Keyboard shortcuts and UI controls
+- **Data Export**: Export performance metrics to CSV
+
+## Getting Started
+
+```bash
+# Install dependencies
+npm install
+
+# Start development server
+npm run dev
+
+# Build for production
+npm run build
+
+# Preview production build
+npm run preview
+```
+
+## Controls
+
+- **G** - Toggle grid display
+- **M** - Toggle metrics display
+- **E** - Export metrics to CSV
+
+## Architecture
+
+```
+src/
+├── main.js - Application entry point and orchestration
+├── waterfall.js - Waterfall graph visualization component
+└── metrics.js - Performance metrics collection and analysis
+```
+
+## Performance Comparison
+
+This implementation can be directly compared with:
+- Rust/wgpu version (`../src/`)
+- C++ version (`../cpp-timeplot/`)
+
+All three implementations track the same metrics for fair comparison.