Update README.md

This commit is contained in:
Youwen Wu 2024-02-26 22:50:14 -08:00 committed by GitHub
parent 434671b4a2
commit 3bde63db02
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

View file

@ -4,20 +4,23 @@ A remastered version of the original Jankboard, with a focus on minimizing the J
The frontend is powered by Svelte 4 (unfortunately, we had to drop support for the bleeding edge Svelte 5 due to lack of Vite support).
This project is closed source (for now) and licensed under a modified BSD 3.0 license.
## Current progress
## Current progress and improvements over (original) Jankboard
- Basic UI layout complete
- Media player working with a few small issues
- App system working smoothly
- Camera feed likely working
- Frontend syncs basic telemetry data with robot through the same Socket-IO code that powered Jankboard v1
- Notification service installed, with Toast and audio capability
- Layout, toasts/notifications, music player, and app system ported.
- Toast and audio cue system is much more robust
- Transitions added almost everywhere to make things smoother
- Tauri app created successfully, currently still using Flask backend
- Visualization vastly improved with Threlte (Three.js) powered 3D robot simulation
- Robot model ported successfully via massive optimization through polygon decimation
- Added settings app with options to disable certain features and developer tools for testing
## TODO
- Camera cutout overlay
- Overhaul audio player system
- Robot visualization (3D, in Threlte).
- Overhaul backend
- Overhaul visualization (especially camera)
- Overhaul backend in Rust
- Further integrate telemetry (like GPWS, collision warning, etc)
- Finish re-creating / adding various voice alerts and sequences
- Create dynamic voice prompt system to support new languages very easily
- Add dynamic voice prompt fallback to support incremental voice prompt migration