lv_port_pc_visual_studio Difficult to Use for Programmers New to LVGL #102
Description
I first used lv_port_pc_visual_studio when all the examples were present, but commented out. This was "the clue" that helped me get started -- I could see it was intended to simply un-comment the example I wanted to run. And a quick test proved this to be true. Having all of these examples present was powerful and enabled me to try out a dozen examples with just a few keystrokes and without a lot of "hunting around" to find them.
Now there is only one example, and there are no instructions (at least that I have found) about how to use the application and benefit from the vast number of examples. Unfortunately, currently, it is not obvious to a programmer new to LVGL that the "power" of this application is right above the while(1) {...} loop at the bottom of the main file.
When I go looking for instructions, I look for them in the file that has:
int main()
{
...in it. My tendency as a career programmer is to look for such instructions (in this sequence):
- at the top of the file containing
int main(), - as a comment over the
main()function, - near the actual call to the example to build the Widget tree for the demo,
- the project's
README.md.
Right or wrong, that is actually the real sequence in which I looked for instructions. I suspect other programmers might follow that same pattern.
If it is alright with you (@kisvegabor @MouriNaruto ) I will:
- update the
README.mdto reflect that all the examples can be found in the LVGL submodule's./examples/directory, - add brief instructions at the top of the main file to look at the bottom of the file (above the
while()loop) for instructions on how to use it, - add instructions with a small number of (commented-out) examples where the Widget tree is created right before the
lv_timer_handler()loop at the bottom.
This will help programmers new to LVGL get started with this project when they are on a Windows system.
Kind regards,
Victor Wheeler