Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Wiki documentation for examples & elements #78

Closed
ImpulseAdventure opened this issue Nov 6, 2018 · 4 comments
Closed

Wiki documentation for examples & elements #78

ImpulseAdventure opened this issue Nov 6, 2018 · 4 comments
Milestone

Comments

@ImpulseAdventure
Copy link
Owner

As the number of examples has grown, it would be helpful to create a set of pages in the wiki to show what each of the examples look like and the features that each demonstrates.

In addition, a gallery of each element type should also be provided.

@espHorst
Copy link
Contributor

espHorst commented Nov 6, 2018

Would it be possible to extend the name of each example by a short word describing the example? E.g. adding "_rotate" or "_touch_handler" ... ? This would really help in remembering the examples when choosing them from the arduino IDE without the need to open each time the wiki.

@ImpulseAdventure
Copy link
Owner Author

Sounds reasonable. I will be updating the README.md in each of the examples directory to include an a basic description of each example. However, renaming the directories to include the general function (unfortunately eliminating the visible git changelog in the process) would be worthwhile as it would also address offline identification.

@ImpulseAdventure
Copy link
Owner Author

Initial list of examples has been added to the wiki: (more details & screenshots to be added later)
Wiki: GUIslice Gallery of Included Examples

@ImpulseAdventure
Copy link
Owner Author

Completed renaming of all examples to use a descriptive name in the title.
This should make it much easier to locate a specific example.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants