clarity

README.md

@@ -1,31 +1,35 @@
 # braille_xr
-refreshable braille display for rendering and input
+refreshable braille display for rendering and input with handtracking
 
-## Setup
+**[ disclaimer ]**  
+this early repo may require special help/information depending on your setup and prior knowledge - so do not hesitate to reach out to [@spatialfree](https://x.com/spatialfree) with any questions!
 
-!!! edit _wifi_config.h to setup your wifi credentials first
+## init
+### required
+- [dotnet sdk](https://dotnet.microsoft.com/en-us/download) v8
+### optional (*if you know what you are doing)  
+- [vscode](https://https://code.visualstudio.com/)
+- [arduino extension](https://marketplace.visualstudio.com/items?itemName=vsciot-vscode.vscode-arduino)
+
+## setup
+- enter your wifi credentials in ```hardware/braille_xr/_wifi_config.h``` --removing the leading underscore in the filename so it get's included in sketch (and gitignored)
 ```shell
-# + on linux make sure you can r/w
+# *on linux make sure you can r/w
 sudo chmod 666 /dev/ttyUSB0
 ```
+- open the serial monitor and upload the sketch to your board
+- if successful after a series of connection codes it will print out the ip of your device and await input from the sk_demo
+- before running the demo with ```dotnet run``` please replace the ip value in ```sk_demo/src/MonoNet.cs``` with your boards ip address
 
-### Hardware Required
+*currently the demo simply changes the displayed character as the tracked r_hand is moved along the x axis*
 
+### hardware
 - 6x 9g servos
-- arduino board / with breakout board for powering the servos
+- esp32 board / with breakout pins+power for the servos
 - ...
 
-### Software Dependencies
-
-- OpenXR
-- StereoKit
-
-## Run
-
-```shell
-# ...
-```
-
-## Shout-Outs
-
-Bryan Chris Brown, StereoNick, Peter Sassaman, Lucas De Bonet (LucidVR)
+## <3
+[Bryan Chris Brown](https://twitter.com/BryanChrisBrown)  
+[StereoNick](https://twitter.com/koujaku)  
+[Peter Sassaman](https://twitter.com/PeterSassaman)  
+[Lucas De Bonet (LucidVR)](https://twitter.com/VrLucid)