Skip to content

Commit 44a55bc

Browse files
committed
docs: clean up README formatting and remove duplicate sections
- Fix table alignment in Remote Control Key Mappings - Remove duplicate Testing and Code Quality sections - Add proper spacing in Troubleshooting section headers - Remove yarn lint:all from workspace commands table (redundant)
1 parent cefccc0 commit 44a55bc

1 file changed

Lines changed: 22 additions & 36 deletions

File tree

README.md

Lines changed: 22 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -263,7 +263,6 @@ yarn build
263263
| `yarn dev:web` | Run on Web |
264264
| `yarn dev:vega` | Start vega Metro bundler |
265265
| `yarn build:vega` | Build vega for Fire TV |
266-
| `yarn lint:all` | Lint all packages |
267266
| `yarn format` | Format code with Prettier |
268267
| `yarn clean:all` | Clean all node_modules |
269268

@@ -371,48 +370,24 @@ All managers implement `RemoteControlManagerInterface` and integrate with `react
371370

372371
The following keys are supported across all platforms in the video player:
373372

374-
| Key/Button | Action | Platforms |
375-
| ------------- | ------------------------------- | ---------------------- |
376-
| PlayPause | Toggle play/pause | All |
377-
| Select/Enter | Activate focused item | All |
378-
| Back | Exit player or go back | All |
379-
| Left | Seek backward 10 seconds | All (in player) |
380-
| Right | Seek forward 10 seconds | All (in player) |
381-
| FastForward | Seek forward 10 seconds | All (in player) |
382-
| Rewind | Seek backward 10 seconds | All (in player) |
383-
| Up/Down | Navigate menu items | All (in navigation) |
373+
| Key/Button | Action | Platforms |
374+
| ------------ | ------------------------ | ------------------- |
375+
| PlayPause | Toggle play/pause | All |
376+
| Select/Enter | Activate focused item | All |
377+
| Back | Exit player or go back | All |
378+
| Left | Seek backward 10 seconds | All (in player) |
379+
| Right | Seek forward 10 seconds | All (in player) |
380+
| FastForward | Seek forward 10 seconds | All (in player) |
381+
| Rewind | Seek backward 10 seconds | All (in player) |
382+
| Up/Down | Navigate menu items | All (in navigation) |
384383

385384
**Platform-Specific Notes:**
385+
386386
- **iOS/tvOS**: Uses native video controls by default; custom overlay disabled
387387
- **Android TV/Fire TV**: Custom overlay with spatial navigation for all controls
388388
- **Web**: Keyboard support with arrow keys and spacebar for play/pause
389389
- **Fire TV Vega**: Hardware-accelerated video with W3C Media APIs
390390

391-
### Testing
392-
393-
```bash
394-
# Run all tests
395-
yarn test:all
396-
397-
# Test specific package
398-
yarn workspace @multi-tv/shared-ui test
399-
yarn workspace @multi-tv/expo-multi-tv test
400-
yarn workspace @multi-tv/vega test
401-
```
402-
403-
### Code Quality
404-
405-
```bash
406-
# Lint all code
407-
yarn lint:all
408-
409-
# Type check
410-
yarn typecheck
411-
412-
# Format code
413-
yarn format
414-
```
415-
416391
## Technologies
417392

418393
This project is built with modern React Native and TV development tools:
@@ -455,10 +430,12 @@ Contributions are welcome! This project is an open-source sample designed to hel
455430
### iOS Build Issues
456431

457432
**Error: "can't access lexical declaration 'X' before initialization"**
433+
458434
- This typically occurs when functions are referenced before they're defined
459435
- Solution: Functions should be defined before useEffect hooks that reference them
460436

461437
**Error: "No such file or directory: node"**
438+
462439
- The Xcode build can't find the Node.js binary
463440
- Solution: Update `apps/expo-multi-tv/ios/.xcode.env.local` with correct Node path:
464441
```bash
@@ -468,6 +445,7 @@ Contributions are welcome! This project is an open-source sample designed to hel
468445
- Note: `.xcode.env.local` is gitignored (machine-specific configuration)
469446

470447
**Pods Installation Issues**
448+
471449
- Clean and reinstall:
472450
```bash
473451
cd apps/expo-multi-tv/ios
@@ -478,12 +456,14 @@ Contributions are welcome! This project is an open-source sample designed to hel
478456
### Android TV Build Issues
479457

480458
**Metro Bundler Port Conflicts**
459+
481460
- If port 8081 is in use:
482461
```bash
483462
yarn start --port 8082
484463
```
485464

486465
**ADB Device Not Found**
466+
487467
- Ensure Android TV/Fire TV is connected:
488468
```bash
489469
adb devices
@@ -493,37 +473,43 @@ Contributions are welcome! This project is an open-source sample designed to hel
493473
### Fire TV Vega Issues
494474

495475
**Vega SDK Not Found**
476+
496477
- Ensure Vega SDK is installed and in PATH
497478
- Check SDK path: `echo $KEPLER_SDK_HOME`
498479
- Download from: [Amazon Vega Developer Portal](https://developer.amazon.com/vega)
499480

500481
### Web Platform Issues
501482

502483
**Video Player White Screen**
484+
503485
- Check browser console for JavaScript errors
504486
- Ensure catalog API is accessible
505487
- Verify video URLs are CORS-enabled
506488

507489
**Spatial Navigation Not Working**
490+
508491
- Use keyboard arrows for navigation on web
509492
- Focus management requires keyboard or gamepad input
510493

511494
### Common Issues
512495

513496
**"Module not found" Errors**
497+
514498
- Clear cache and reinstall:
515499
```bash
516500
yarn clean:all
517501
yarn install
518502
```
519503

520504
**TypeScript Errors**
505+
521506
- Run type checking:
522507
```bash
523508
yarn typecheck
524509
```
525510

526511
**Video Playback Issues**
512+
527513
- Verify video URLs are accessible
528514
- Check network connectivity
529515
- Ensure video format is supported (MP4 recommended)

0 commit comments

Comments
 (0)