Skip to content
This repository has been archived by the owner on Sep 24, 2019. It is now read-only.

Create README file for each example including image/snapshot? #1

Open
amirhouieh opened this issue Mar 27, 2018 · 2 comments
Open

Create README file for each example including image/snapshot? #1

amirhouieh opened this issue Mar 27, 2018 · 2 comments

Comments

@amirhouieh
Copy link

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.

@edwinRNDR
Copy link
Member

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

@amirhouieh
Copy link
Author

amirhouieh commented Mar 28, 2018

@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 amirhouieh changed the title Add visual reference for each example? Create README file for each example including image/snapshot? Mar 28, 2018
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants