openrndr-tutorials icon indicating copy to clipboard operation
openrndr-tutorials copied to clipboard

Create README file for each example including image/snapshot?

Open amirhouieh opened this issue 6 years ago • 2 comments

I think is good that if each example README contains an image/snapshop of the output of that example. @edwinRNDR I can get on it, if you agree.

amirhouieh avatar Mar 27 '18 13:03 amirhouieh

@amirhouieh That's good. Let's set some style guidelines first; including simple things like the common window size, should window chrome be included?

edwinRNDR avatar Mar 27 '18 17:03 edwinRNDR

@edwinRNDR good idea. Most of examples use the default window sizes (640, 480), so I would say lets use this dimensions. I think we should include window chrome, since it would indicate openRNDR immediately, and it just feels right to me.

Btw, we are missing README files as well. So here is a simple structure I propose:

Title of example
Short explanation about what this is (same as comments in the code)
[image]

amirhouieh avatar Mar 28 '18 08:03 amirhouieh