refactor: edit readme and dummy commit to trigger actions

This commit is contained in:
DaOfficialWizard 2023-08-24 22:40:11 +01:00 committed by GitHub
parent 6e761d4201
commit f5695f00a8
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -3,8 +3,6 @@ Picture courtesy of Wackalope#6737
[![GitHub issues](https://img.shields.io/github/issues/RedHawk989/EyeTrackVR?style=plastic)](https://github.com/RedHawk989/EyeTrackVR/issues) [![GitHub forks](https://img.shields.io/github/forks/RedHawk989/EyeTrackVR?style=plastic)](https://github.com/RedHawk989/EyeTrackVR/network) [![GitHub stars](https://img.shields.io/github/stars/RedHawk989/EyeTrackVR?style=plastic)](https://github.com/RedHawk989/EyeTrackVR/stargazers)
[![Project Card](https://project-card-app.herokuapp.com/project_card/RedHawk989/EyeTrackVR)](https://github.com/RedHawk989/EyeTrackVR)
- [EyeTrackVR](#eyetrackvr)
- [This project is in development and is not fully finished](#this-project-is-in-development-and-is-not-fully-finished)
- [Hardware](#hardware)
@ -21,28 +19,21 @@ Picture courtesy of Wackalope#6737
Open source and *affordable* VR eye tracker platform for [VRChat](https://hello.vrchat.com/) via `OSC` and `UDP` protocol.
> **Note**: This project is in active development and is not fully finished
> [!IMPORTANT]\
> This project is in active development and is not fully finished
## Documentation
Please check out our [documentation site](https://redhawk989.github.io/EyeTrackVR/)
## Hardware
3d files for mounting brackets will be found [here](https://github.com/RedHawk989/EyeTrackVR-Hardware)
IR emitter files are also located there. For more info please reference our parts list on our [documentation site](https://redhawk989.github.io/EyeTrackVR/parts-list/)
## ESP-CAM Firmware
Current work has been with our official firmware by `lorow`, found [here](https://github.com/lorow/OpenIris).
## Headset support
Any headset that can fit the camera and LEDs can likely be supported, however, mounts may not have been made for it. Please reference to our [parts list](https://redhawk989.github.io/EyeTrackVR/parts-list/#other-parts) for details.
@ -56,7 +47,8 @@ Please *exercise extreme caution* when messing around with IR emitters.
The safety measures were put in place to REDUCE the potential failure risk. All further safety responsibilities are on the user.
This includes visually checking with an IR camera that the brightness is correct and making sure you do not feel warmth.
> **Warning**: Make sure you are using **NON-focused** emitters and at around ***5ma total power per eye***.
> [!WARNING]\
> Make sure you are using **NON-focused** emitters and at around ***5ma total power per eye***.
[Effect of infrared radiation on the lens](https://github.com/RedHawk989/EyeTrackVR/blob/docs/docs/Reference_Docs/saftey/effect_of_ir_on_the_lens.pdf)
@ -64,9 +56,6 @@ This includes visually checking with an IR camera that the brightness is correct
[AN002_Details on photobiological safety of LED light sources](https://github.com/RedHawk989/EyeTrackVR/blob/docs/docs/Reference_Docs/saftey/AN002_Details_on_photobiological_safety_of_LED_light_sources.pdf)
## Contact
Please join our Discord for updates and any questions.