Readme additions - development details and additional context

acmerobotics / ftc-dashboard

React-based web dashboard designed for FTC

https://acmerobotics.github.io/ftc-dashboard

Other

168 stars 125 forks source link

Readme additions - development details and additional context #128

Closed NoahBres closed 1 year ago

NoahBres commented 1 year ago

Documentation PR. Necessary for long development cycles with loss of context after long periods

Adds additional feature bullet points
Adds additional screenshots
Add basic installation instructions
Add browser client development instructions
- Include misc details like Node 16+ required for M1
- Include default IP's
Add basic architecture details
- Java server + browser client source links
Add relevant file links
Add mock server instructions

NoahBres commented 1 year ago

About time the README screenshot was updated. Would be great if this gets more people contributing!

Still not the best and would eventually like some more feature filled samples; but hopefully some incremental improvements provide value in the meantime!

NoahBres commented 1 year ago

Idk if you intended to fix up the suggestions yourself but I have not fully resolved all the comments.

rbrott commented 1 year ago

Yeah no worries. I made the last few changes myself.

NoahBres commented 1 year ago

Awesome!!