KallistiOS icon indicating copy to clipboard operation
KallistiOS copied to clipboard

Reference Screenshots/Videos/explanations for examples

Open QuzarDC opened this issue 1 year ago • 3 comments

While building and running examples to test changes to core video functionality ( #150 ) I realized that despite being able to see the code of any number of examples it was difficult to tell if the output was as expected. Sure, there was a pattern and text in examples/dreamcast/video/bfont but was it the right colors, pattern, and text?

So the proposal here would be to, as a standard practice, include pixel-perfect screenshots for examples that have visual output, and transcripts of the expected output for those that have text output. In lieu of either, more detailed explanations of the expected output would be useful.

Aside from mere comprehension, screenshots and transcripts could form the basis of automated regression testing.

So, with that, I open the floor to other sorts of possible suggestions for improving and expanding the examples.

QuzarDC avatar Apr 25 '23 05:04 QuzarDC