search

debug-edge / DebugEdge

A small bridge to link a SWD programmer to an AVX Open Ended Card Edge connector.
https://debug-edge.io
Other
39 stars 11 forks source link

Improve readme and documentation #15

Closed RX14 closed 3 years ago

RX14 commented 3 years ago

Hi!

I found this repository and idea, and I thought it was a really good idea! But since there was no link to debug-edge.io, I didn't find the full documentation and only had .images/debug_edge_v1.png, which didn't mention UART, so I started designing my own pinout with RX/TX pins instead of TRACE, because I thought this standard didn't help me! But, luckily I eventually found your full website where the rationale and full pinout was listed, realised your design was better, and switched back!

I realised that this oopsie would have been avoided if there was better access to the documentation from this repo, since it's probably the main jumping in point of people looking at DebugEdge. So I've removed the old image from the repo, in favour of a link to the more up to date one on the website, and made sure to link to the website. Would be nice to get the repo's URL changed to debug-edge.io too, so it's even harder to miss!

nitz commented 3 years ago

Excellent! Thank you so much!

tannewt commented 3 years ago

Thanks! I've added the URL to the repo settings as well.