Giters

lvgl / lv_demos

Examples, tutorials and applications for the LVGL embedded GUI library

Home Page:https://lvgl.io

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

[Request] Update README and add README to each example

C47D opened this issue · comments

commented

The main README still refers to the examples using LVGL v6, how can it be updated?

The purpose of a README on each example would be to list the requirements it needs (fonts, LVGL special configuration, etc.), and features it shows.

commented

I like the idea. I suggest that we just get rid of all the example-specific information in the main README and simply mention that each example has its own README.

commented

I've gone ahead and removed the outdated information in 5c75a3e since it's not relevant anymore.

commented

We could list the examples on the main README and use markdown links to refer to each example README, something like this:

Examples:
lv_demo_benchmark: More info [here](relative_path_to_lv_demo_benchmark_readme).
...
commented

Sounds good! I'll add it later today. I'm planning to write 1-2 sentences to each folder.
E.g.

- Widget examples: Simple examples to demonstrate the features of the widgets.  
                   See them in [lv_ex_widgets](...).
commented

I've added the examples

commented

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.