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

docs: specify release version branch #128

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

JPHutchins
Copy link

This adds a note to the master branch explaining that different versions of LVGL have corresponding simulator examples. This approach has several deficiencies.

  • the README.md now diverges (master is different than the branches)
    • somewhat justifiable in the sense that if you got to a release branch you probably already knew you should be there
  • perhaps the REAMDE.md of each branch should clearly state what dependencies they are using; e.g., the master branch would state "LVGL Simulator for latest LVGL master"?
  • perhaps this sort of clarification should exist here, https://docs.lvgl.io/latest/en/html/get-started/pc-simulator.html, instead?

@JPHutchins
Copy link
Author

A better solution might be for this page, https://docs.lvgl.io/8.2/get-started/pc-simulator.html?highlight=simulator, to link to the compatible 8.2 branch, for example. Though, that's still implicit.

@kisvegabor
Copy link
Member

kisvegabor commented Aug 31, 2023

Thank you for the update.

I think most of the people are interested in either the the release/v8.3 or the mater branch. As the master branch's README is visible by default, I think it should act as a hub to navigate people to the right place.

E.g. - as you suggested - say that "it's the master branch for LVGL master, if you need v8.3 click here". I think it's quite simple and still helpful. What do you think?

@JPHutchins
Copy link
Author

@kisvegabor Good idea, I will give it a shot!

@kisvegabor
Copy link
Member

Looks great, thank you!

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

Successfully merging this pull request may close these issues.

2 participants