github-code/lvgl
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs update CHANGELOG, CONTRIBUTING and ROADMAP

Browse Source
This commit is contained in:
Gabor Kiss-Vamosi
2021-05-18 11:07:01 +02:00
parent d505429dd8
commit 76fe4148b5
3 changed files with 141 additions and 103 deletions
Download Patch File Download Diff File Expand all files Collapse all files

70
docs/CHANGELOG.md
View File

@@ -1,5 +1,75 @@
# Changelog # Changelog
## v8.0.0 (Planned in May 2021)
### Directory structure
- The `lv_` prefix is removed from the folder names
- The `docs` is moved to the `lvgl` repository
- The `examples` are moved to the `lvgl` repository
- Create an `src/extra` folder for complex widgets:
- It makes the core LVGL leaner
- In `extra` we can have a lot and specific widgets
- Good place for contributions
### Removed objects
- `lv_cont` layout features are moved to `lv_obj`
- `lv_page` scroll features are moved to `lv_obj`
- `lv_objmask` the same can be achieved by events
### New scrolling
- Support "elastic" scrolling when scrolled in
- Support scroll chaining among any objects types (not only `lv_pages`s)
- Remove `lv_drag`. Similar effect can be achieved by setting the position in `LV_EVENT_PRESSING`
- Add snapping
- Add snap stop to scroll max 1 snap point
### New layouts
- [CSS Grid](https://css-tricks.com/snippets/css/a-guide-to-grid/)-like layout support
- [CSS Flexbox](https://css-tricks.com/snippets/css/a-guide-to-flexbox/)-like layout support
### Styles
- Optimize and simplify styles
- State is saved in the object instead of the style property
- Object size and position can be set in styles too
### Events
- Allow adding multiple events to an object
- A `user_data` can be attached to the added events
### Driver changes
- `lv_disp_drv_t`, `lv_indev_drv_t`, `lv_fs_drv_t` needs to be `static`
- `...disp_buf...` is renamed to `draw_buf`. See an initialization example [here](https://github.com/lvgl/lv_sim_eclipse_sdl/blob/e164e3591c3e1e3bf3464d19e0dcdc67b2e6a791/main.c#L87-L97).
- No partial update if two screen sized buffers are set
- `disp_drv->full_refresh = 1` makes always the whole display redraw.
- `hor_res` and `ver_res` need to be set in `disp_drv`
- `indev_read_cb` returns `void`. To indicate that there is more that to read set `data->continue_reading = 1` in the `read_cb`
.
### Other changes
- Remove the copy parameter from create functions
- Simplified File system interface API
- Use a more generic inheritance
- The built-in themes are reworked
- `lv_obj_align` now saved the alignment and realigns the object automatically but can't be used to align to other than the parent
- `lv_obj_align_to` can align to an object but doesn't save the alignment
- `lv_pct(x)` can be used to set the size and position in percentage
- There are many other changes in widgets that are not detailed here. Please refer to the documentation of the widgets.
### New release policy
- We will follow [Release branches with GitLab flow](https://docs.gitlab.com/ee/topics/gitlab_flow.html#release-branches-with-gitlab-flow)
- Minor releases are expected in every 3-4 month
- `master` will always contain the latest changes
### Migrating from v7 to v8
- First and foremost, create a new `lv_conf.h` based on `lv_conf_template.h`.
- To try the new version it suggested using a simulator project and see the examples.
- When migrating your project to v8
- Update the drivers are described above
- Update the styles
- Update the events
- Use the new layouts instead of `lv_cont` features
- Use `lv_obj` instead of `lv_page`
- The other parts are mainly minor renames and refactoring. See the functions' documentation for descriptions.
## v7.11.0 ## v7.11.0
### New features ### New features

104
docs/CONTRIBUTING.md
View File

@@ -100,16 +100,15 @@ For example in case of StackOwerflow a notice like this can be used:
As LVGL is also MIT licensed other MIT licensed code can be integrated without issues. As LVGL is also MIT licensed other MIT licensed code can be integrated without issues.
The MIT license requests a copyright notice be added to the derived work. So you need to copy the original work's license file or it's text to the code you want to add. The MIT license requests a copyright notice be added to the derived work. So you need to copy the original work's license file or it's text to the code you want to add.
#### Use GPL licensed code #### Use GPL licensed code
As GPL license is not compatible with MIT license so LVGL can not accept GPL licensed code. As GPL license is not compatible with MIT license so LVGL can not accept GPL licensed code.
## Ways to contribute
Even if you're just getting started with LVGL there are plenty of ways to get your feet wet.
Most of these options don't even require knowing a single line of LVGL code.
Below we have collected some opportinuties about the ways you can contribute to LVGL.
## When you get started with LVGL
Even if you're just getting started with LVGL there are plenty of ways to get your feet wet. Most of these options don't even require knowing a single line of code of LVGL.
### Give LVGL a Star ### Give LVGL a Star
@@ -124,71 +123,46 @@ So with this, you already helped a lot!
### Tell what you have achieved ### Tell what you have achieved
Have you already started using LVGL in a [Simulator](/get-started/pc-simulator), a development board, or your custom hardware? Have you already started using LVGL in a [Simulator](/get-started/pc-simulator), a development board, or on your custom hardware?
Was it easy or were there some obstacles? Are you happy with the result? Was it easy or were there some obstacles? Are you happy with the result?
Showing your project to others is a win-win situation because it increases yours and LVGL's reputation at the same time.
If so why don't you tell it to your friends? You can post it on Twitter, Facebook, LinkedIn, or create a YouTube video. You can post about your project on Twitter, Facebook, LinkedIn, create a YouTube video, and so on.
Only one think: on social media don't forget to add a link to `https://lvgl.io` or `https://github.com/lvgl` and `#lvgl`. Thank you! :)
You can also open a new topic in the [My projects](https://forum.lvgl.io/c/my-projects/10) category of the Forum.
The [LVGL Blog](https://blog.lvgl.io) welcomes posts from anyone.
It's a good place to talk about a project you created with LVGL, write a tutorial, or share some nice tricks.
The latest blog posts are shown on the [homepage of LVGL](https://lvgl.io) to make your work more visible.
The blog is hosted on GitHub. If you add a post GitHub automatically turns it into a website.
See the [README](https://github.com/lvgl/blog) of the blog repo to see how to add your post.
Any of these helps a lot to spread the word of LVGL and familiarize it with new developers. Any of these helps a lot to spread the word of LVGL and familiarize it with new developers.
Only thing: don't forget to add a link to `https://lvgl.io` or `https://github.com/lvgl` and `#lvgl`. Thank you! :) If you don't want to speak about it publicly feel free to use [Contact form](https://lvgl.io/#contact) on lvgl.io to private message to us.
### Write examples ### Write examples
As you learn LVGL probably you will play with the features of widgets. But why don't you publish your experiments? As you learn LVGL probably you will play with the features of widgets. But why don't you publish your experiments?
Every widgets' documentation contains some examples. For example here are the examples of the [Drop-down list](#example). Every widgets' documentation contains some examples. For example here are the examples of the [Drop-down list](/widgets/core/dropdown#examples).
The examples are directly loaded from the [lv_examples](https://github.com/lvgl/lv_examples/tree/master/src/lv_ex_widgets) repository. The examples are directly loaded from the [lvgl/examples](https://github.com/lvgl/lvgl/tree/master/examples) folder.
So all you need to do is send a [Pull request](#pull-request) to the [lv_examples](https://github.com/lvgl/lv_examples/tree/master/src/lv_ex_widgets) repository and follow some conventions: So all you need to do is send a [Pull request](#pull-request) to the [lvgl](https://github.com/lvgl/lvgl) repository and follow some conventions:
- Name the examples like `lv_ex_<widget_name>_<id>` - Name the examples like `lv_example_<widget_name>_<indes>`
- Make the example as short and simple as possible - Make the example as short and simple as possible
- Add comments to explain what the example does - Add comments to explain what the example does
- Use 320x240 resolution - Use 320x240 resolution
- Create a screenshot about the example
- Update `index.rst` in the example's folder with your new example. See how the other examples are added. - Update `index.rst` in the example's folder with your new example. See how the other examples are added.
### Improve the docs ### Improve the docs
As you read the documentation you might see some typos or unclear sentences. As you read the documentation you might see some typos or unclear sentences. All the documentation is localed in the [lvgl/docs](https://github.com/lvgl/lvgl/tree/master/docs) folder.
For typos and straightforward fixes, you can simply edit the file on GitHub. There is an `Edit on Github` link on the top right-hand corner of all pages. For typos and straightforward fixes, you can simply edit the file on GitHub.
Click it to see the file on GitHub, hit the Edit button, and add your fixes as described in [Pull request - From GitHub](#from-github) section.
Note that the documentation is also formatted in [Markdown](https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet). Note that the documentation is also formatted in [Markdown](https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet).
### Translate the docs
If you have more free time you can even translate the documentation. The currently available languages are shown in the [locals](https://github.com/lvgl/docs/tree/latest/locales) folder.
If your chosen language is still not added, please write a comment [here](https://forum.lvgl.io/t/translate-the-documentation/238).
To add your translations:
- Find the *.po* in `<language_code>/LC_MESSAGES/<section_name>.po`. E.g. the widgets translated to German should be in `de/LC_MESSAGES/widgets.po`.
- Open a po file and fill the `msgstr` fields with the translation
- Send a [Pull request](#pull-request)
To display a translation in the public documentation page at least these sections should be translated:
- Get started: Quick overview
- Overview: Objects, Events, Styles
- Porting: System overview, Set-up a project, Display interface, Input device Interface, Tick interface
- 5 widgets of your choice
### Write a blog post
The [LVGL Blog](https://blog.lvgl.io) welcomes posts from anyone. It's a good place to talk about a project you created with LVGL, write a tutorial, or share some nice tricks.
The latest blog posts are shown on the [homepage of LVGL](https://lvgl.io) to make your work more visible.
The blog is hosted on GitHub. If you add a post GitHub automatically turns it into a website. See the [README](https://github.com/lvgl/blog) of the blog repo to see how to add your post.
## When you already use LVGL
### Give feedback
Let us know what you are working on! You can open a new topic in the [My projects](https://forum.lvgl.io/c/my-projects/10) category of the Forum.
Showing your project to others is a win-win situation because it increases your and LVGL's reputation at the same time.
If you don't want to speak about it publicly feel free to use [Contact form](https://lvgl.io/#contact) on lvgl.io to private message to us.
### Report bugs ### Report bugs
As you use LVGL you might find bugs. Before reporting them be sure to check the relevant parts of the documentation. As you use LVGL you might find bugs. Before reporting them be sure to check the relevant parts of the documentation.
@@ -214,21 +188,18 @@ Just read the titles and if you are familiar with the topic don't hesitate to sh
Participating in the discussions is one of the best ways to become part of the project and get to know like-minded people! Participating in the discussions is one of the best ways to become part of the project and get to know like-minded people!
### Add features ### Add features
We collect the planned features in GitHub issues tracker and mark them with [Help wanted](https://github.com/lvgl/lvgl/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22) label. We collect the planned features in GitHub on the [Roadmap](/ROADMAP) page. If you are interested in any of them feel free to share your opinion and/or participate in the the implementation.
If you are interested in any of them feel free to share your opinion and/or participate in the the implementation.
Other features which are (still) not on the road map are listed in the [Feature request](https://forum.lvgl.io/c/feature-request/9) category of the Forum. Other features which are (still) not on the road map are listed in the [Feature request](https://forum.lvgl.io/c/feature-request/9) category of the Forum.
If you have a feature idea for LVGL please use the Forum to share it! Make sure to check that there isn't an existing post; if there is, you should comment on it instead to show that there is increased interest in an existing request. If you have a feature idea for LVGL please use the Forum to share it!
Make sure to check that there isn't an existing post; if there is, you should comment on it to show that there is increased interest in an existing request.
When adding a new features the followings also needs to be updated: When adding a new features the followings also needs to be updated:
- Add a line to [CHANGELOG.md](https://github.com/lvgl/lvgl/blob/master/CHANGELOG.md). - Add a line to [CHANGELOG.md](https://github.com/lvgl/lvgl/blob/master/CHANGELOG.md).
- Update the documentation. See this [guide](#improve-the-docs). - Update the documentation.
- Add an example if applicable. See this [guide](#write-examples). - Add an example if applicable. See this [guide](#write-examples).
## When you are confident with LVGL
### Become a maintainer ### Become a maintainer
If you want to become part of the core development team, you can become a maintainer of a repository. If you want to become part of the core development team, you can become a maintainer of a repository.
@@ -238,9 +209,7 @@ By becoming a maintainer:
- add code directly without sending a pull request - add code directly without sending a pull request
- accept pull requests - accept pull requests
- close/reopen/edit issues - close/reopen/edit issues
- your name will be added in the credits section of lvgl.io/about (will be added soon) and lvgl’s README. - your word has higher impact when we makeing decisions
- you can join the [Core_contributor](https://forum.lvgl.io/g/Core_contributor) group in the Forum and get the LVGL logo on your avatar.
- your word has higher impact when we make decisions
You can become a maintainer by invitation, however the following conditions need to met You can become a maintainer by invitation, however the following conditions need to met
1. Have > 50 replies in the Forum. You can look at your stats [here](https://forum.lvgl.io/u?period=all) 1. Have > 50 replies in the Forum. You can look at your stats [here](https://forum.lvgl.io/u?period=all)
@@ -248,19 +217,22 @@ You can become a maintainer by invitation, however the following conditions need
If you are interested, just send a message (e.g. from the Forum) to the current maintainers of the repository. They will check is the prerequisites are met. If you are interested, just send a message (e.g. from the Forum) to the current maintainers of the repository. They will check is the prerequisites are met.
Note that meeting the prerequisites is not a guarantee of acceptance, i.e. if the conditions are met you won't automatically become a maintainer. It's up to the current maintainers to make the decision. Note that meeting the prerequisites is not a guarantee of acceptance, i.e. if the conditions are met you won't automatically become a maintainer.
It's up to the current maintainers to make the decision.
### Move your project repository under LVGL organization ### Move your project repository under LVGL organization
Besides the core `lvgl` repository there are other repos for ports to development boards, IDEs or other environment. If you ported LVGL to a new platform we can host it under the LVGL organization among the other repos. Besides the core `lvgl` repository there are other repos for ports to development boards, IDEs or other environment.
If you ported LVGL to a new platform we can host it under the LVGL organization among the other repos.
This way your project will become part of the whole LVGL project and can get more visibility. If you are interested in this opportunity just open an [issue in lvgl repo](https://github.com/lvgl/lvgl/issues) and tell what you have! This way your project will become part of the whole LVGL project and can get more visibility.
If you are interested in this opportunity just open an [issue in lvgl repo](https://github.com/lvgl/lvgl/issues) and tell what you have!
If we agree that your port is useful, we will open a repository for your project where you will have admin rights. If we agree that your port fit well into the LVGL organisation, we will open a repository for your project where you will have admin rights.
To make this concept sustainable there a few rules to follow: To make this concept sustainable there a few rules to follow:
- You need to add a README to your repo. - You need to add a README to your repo.
- We expect to maintain the repo to some extent: - We expect to maintain the repo to some extent:
- Follow at least the major versions of lvgl - Follow at least the major versions of lvgl
- Respond to the issues (in a reasonable time) - Respond to the issues (in a reasonable time)
- If there is no activity in a repo for 6 months it will be archived - If there is no activity in a repo for 1 year it will be archived

68
docs/ROADMAP.md
View File

@@ -1,11 +1,39 @@
# Roadmap # Roadmap
This is a summary for thenew fatures of the major releases and a collection of ideas. This is a summary for planned new features and a collection of ideas.
This list indicates only the current intention and it can be changed.
This list indicates only the current intention and can be changed. ## v8.X
- Add radio button support
- Unit testing (gtest?). See [#1658](https://github.com/lvgl/lvgl/issues/1658)
- Benchmarking (gem5?). See [#1660](https://github.com/lvgl/lvgl/issues/1660)
- chart: pre-delete `X` pint after the lastly set
- chart: autoscroll to the right
- 9-patch support for `lv_imgbtn`.
- Handle stride. See [#1858](https://github.com/lvgl/lvgl/issues/1858)
- Optimize line and circle drawing and masking
## Ideas
- Reconsider color format management for run time color format setting, and custom color format usage. (Also [RGB888](https://github.com/lvgl/lvgl/issues/1722))
- Make gradients more versatile
- Make image transformations more versatile
- Switch to RGBA colors in styles
- Consider direct binary font format support
- Simplify `group`s. Discussion is [here](https://forum.lvgl.io/t/lv-group-tabindex/2927/3).
- Use [generate-changelog](https://github.com/lob/generate-changelog) to automatically generate changelog
- lv_mem_alloc_aligned(size, align)
- Text node. See [#1701](https://github.com/lvgl/lvgl/issues/1701#issuecomment-699479408)
- CPP binding. See [Forum](https://forum.lvgl.io/t/is-it-possible-to-officially-support-optional-cpp-api/2736)
- Optimize font decompression
- Need coverage report for tests
- Need static analyze (via coverity.io or somehing else)
- Support dot_begin and dot_middle long modes for labels
- Add new label alignment modes. [#1656](https://github.com/lvgl/lvgl/issues/1656)
- Support larger images: [#1892](https://github.com/lvgl/lvgl/issues/1892)
---
## v8 ## v8
Planned to May 2021
- Create an `extra` folder for complex widgets - Create an `extra` folder for complex widgets
- It makes the core LVGL leaner - It makes the core LVGL leaner
- In `extra` we can have a lot and specific widgets - In `extra` we can have a lot and specific widgets
@@ -30,37 +58,5 @@ Planned to May 2021
- Remove the copy parameter from create functions - Remove the copy parameter from create functions
- Optimize and simplifie styles [#1832](https://github.com/lvgl/lvgl/issues/1832) - Optimize and simplifie styles [#1832](https://github.com/lvgl/lvgl/issues/1832)
- Use a more generic inheritenace [#1919](https://github.com/lvgl/lvgl/issues/1919) - Use a more generic inheritenace [#1919](https://github.com/lvgl/lvgl/issues/1919)
- Allow adding multiple events to an obejct
## v8.x
- Add radio button widget
- Unit testing (gtest?). See [#1658](https://github.com/lvgl/lvgl/issues/1658)
- Benchmarking (gem5?). See [#1660](https://github.com/lvgl/lvgl/issues/1660)
- chart: pre-delete `X` pint after the lastly set
- chart: autoscroll to the right
- `lv_snapshot`: buffer a widget and all of its children into an image. he source widget can be on a different screen too. The result image can be transformed.
- 9-patch support for `lv_imgbtn`.
- Handle stride. See [#1858](https://github.com/lvgl/lvgl/issues/1858)
- Rework animation to something like [GSAP](https://greensock.com/gsap/)
- Add scroll trigger inspired by [GSAP scrolltrigger](https://greensock.com/scrolltrigger/)
- Add FLIP inspired by [GSAP FLIP](https://greensock.com/docs/v3/Plugins/Flip/)
## v9
- Simplify `group`s. Discussion is [here](https://forum.lvgl.io/t/lv-group-tabindex/2927/3).
- Consider direct binary font format support
- Optimize line and circle drawing and masking
- Reconsider color format management for run time color format setting, and custom color format usage. (Also [RGB888](https://github.com/lvgl/lvgl/issues/1722))
- Switch to RGBA colors in styles
- Make gradients more versatile
- Make image transformations more versatile
## Ideas
- Use [generate-changelog](https://github.com/lob/generate-changelog) to automatically generate changelog
- lv_mem_alloc_aligned(size, align)
- Text node. See [#1701](https://github.com/lvgl/lvgl/issues/1701#issuecomment-699479408)
- CPP binding. See [Forum](https://forum.lvgl.io/t/is-it-possible-to-officially-support-optional-cpp-api/2736)
- Optimize font decompression
- Need coverage report for tests
- Need static analyze (via coverity.io or somehing else)
- Support dot_begin and dot_middle long modes for labels
- Add new label alignment modes. [#1656](https://github.com/lvgl/lvgl/issues/1656)
- Support larger images: [#1892](https://github.com/lvgl/lvgl/issues/1892)