youwen5/jankboard
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Update README.md

Browse source
This commit is contained in:
Youwen Wu 2024-02-24 02:12:41 -08:00 committed by GitHub
parent 23163b947d
commit 3508746e07
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 12 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

23
README.md
View file

@ -1,22 +1,23 @@
# Jankboard 2 # Jankboard 2
A remastered version of the original Jankboard, with a focus on minimizing the Jank portion. A remastered version of the original Jankboard, with a focus on minimizing the Jank portion. Designed from the ground up to be easy to maintain and extend, unlike the original.
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). 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. This project is closed source (for now) and licensed under a modified BSD 3.0 license.
## Current progress ## Current progress
- Basic UI layout 80% done - Basic UI layout complete
- Media player working with janky bugs - Media player working with a few small issues
- App system working - App system working smoothly
- Camera feed probably working - Camera feed likely working
- Socket IO probably working, but no code set up yet - 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
## TODO ## TODO
- Camera cutout overlay - Camera cutout overlay
- Toasts - Overhaul audio player system
- Audio prompts - Robot visualization (3D, in Threlte).
- Overhaul audio system - Overhaul backend
- Robot visualization - Further integrate telemetry (like GPWS, collision warning, etc)
- Integrate telemetry - Finish re-creating / adding various voice alerts and sequences