Rework the examples repo

[kisvegabor]

This repo should be reworked to make people easier to get started.

My vision is the following

Simple examples

Add very simple examples. It would be nice to use these examples in the documentation too (add lv_examples as a submodule to docs). I was collecting the recurring questions which could be answered with examples:

• [x] mbox: modal (@embeddedt, lv_ex_mbox_2)
• [x] slider: move the slider and set a label's text (@embeddedt, lv_ex_slider_2)
• [ ] button: styling
• [x] image: recolor (@embeddedt, lv_ex_img_2)
• [ ] label: styling
• [x] label: text shadow (@embeddedt, lv_ex_label_2)
• [x] text area: password and one line mode (@embeddedt, lv_ex_ta_2)
• [ ] text area: finish on Enter
• [ ] text area: format text (e.g automatically add dots for IP address)
• [ ] image: slide show animation
• [ ] image: mosaic wallpaper
• [x] display driver test (aded in FAQ)

Ready to use / easy to modify applications

• [x] Android like menu LINK
• [ ] Car dashboard
• [ ] File browser
• [ ] Home automatization
• [ ] Audio players
• [ ] WiFi connect
• [ ] All in one example to show LittlevGL's features Example

External libraries

Create a separate repo for examples when external libraries are used:

• [x] PNG decoder
• [ ] JPG decoder
• [ ] Video player
• [x] QR code
• [x] FatFS and Windows/Unix fs integration. Here I've already started something
• [x] FreeType

Blog post

Create blog posts about longer, more complex topics

• [ ] responsive: fit, auto realign, layout, LV_DPI
• [ ] optimizations for monocrome: round, pixel_wr
• [ ] OSD menu
• [x] FAQ: added to the documentation's welcome page instead

Tutorials

• lv_tutorial should be removed as it makes the examples and documentation fragile

Tests

• lv_tests are not designed for the users, so they can go to a separate repo: lv_tets

Feedback is very welcome

[kisvegabor]

Maybe we could get some inspiration/ideas from Android file managers.

Absolutely yes!

[puzrin]

Good question. Examples are simple, short and related only to a specific object type. (the are listed in the documentation of object types).

I think, if you don't plan to have 1000 doc examples & 1000 "simple" app examples, it's ok to keep both in one place.

Criteria related only to a specific object type may be a bit artificial (tough i can understand initial intent). It may be importand if you use some specific autogeneration from doc, but as far as i know, that's not our case.

[embeddedt]

@puzrin I guess a better way of stating it is that we are aiming to demonstrate a capability of a single object type. For example, the image recoloring demo contains sliders but is really meant to demonstrate recoloring.

[kisvegabor]

As @embeddedt said the goal of the simple examples is to demonstrate a specific feature or use-case of an object type.

So the final conclusion seems to be:

• simple examples in lv_examples repo. These examples automatically included to the docs
• apps are in lv_apps repo which can be enabled on by one with defines
• ext lib examples in separate repos

Do you agree?

[stale[bot]]

This issue or pull request has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

[kisvegabor]

Not stale

[kisvegabor]

I've just added the png_decoder library: https://github.com/littlevgl/lv_png_decoder

[kisvegabor]

I've also added run time font rendering with FreeType: https://github.com/littlevgl/lv_freetype

[kisvegabor]

QR code library is added: https://github.com/littlevgl/lv_lib_qrcode

[incity]

I've just added the png_decoder library: https://github.com/littlevgl/lv_png_decoder

Will you add jpg support?

[kisvegabor]

I was considering to add Tiny JPED Dec but didn't have time to add it yet.

I opened a "help-wanted" issue here about it.

---

This issue is quite outdated so I close it now.