summaryrefslogtreecommitdiff
path: root/src/libs/lvgl/docs
diff options
context:
space:
mode:
authorJean-François Milants <jf@codingfield.com>2021-02-23 21:40:02 +0100
committerJean-François Milants <jf@codingfield.com>2021-02-23 21:53:50 +0100
commit094f98743db630cf070d9fe97e14b24db6450112 (patch)
treee7106bbcf902981ee6ac18364e319400b8a6bb86 /src/libs/lvgl/docs
parent67c545b1fbd368b99b111a1822fe8da815468e76 (diff)
Fix LVGL submodule (sorry!)
Diffstat (limited to 'src/libs/lvgl/docs')
-rw-r--r--src/libs/lvgl/docs/CODE_OF_CONDUCT.md46
-rw-r--r--src/libs/lvgl/docs/CODING_STYLE.md89
-rw-r--r--src/libs/lvgl/docs/CONTRIBUTING.md5
-rw-r--r--src/libs/lvgl/docs/ROADMAP.md63
4 files changed, 0 insertions, 203 deletions
diff --git a/src/libs/lvgl/docs/CODE_OF_CONDUCT.md b/src/libs/lvgl/docs/CODE_OF_CONDUCT.md
deleted file mode 100644
index c7d7eeb1..00000000
--- a/src/libs/lvgl/docs/CODE_OF_CONDUCT.md
+++ /dev/null
@@ -1,46 +0,0 @@
-# Contributor Covenant Code of Conduct
-
-## Our Pledge
-
-In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
-
-## Our Standards
-
-Examples of behavior that contributes to creating a positive environment include:
-
-* Using welcoming and inclusive language
-* Being respectful of differing viewpoints and experiences
-* Gracefully accepting constructive criticism
-* Focusing on what is best for the community
-* Showing empathy towards other community members
-
-Examples of unacceptable behavior by participants include:
-
-* The use of sexualized language or imagery and unwelcome sexual attention or advances
-* Trolling, insulting/derogatory comments, and personal or political attacks
-* Public or private harassment
-* Publishing others' private information, such as a physical or electronic address, without explicit permission
-* Other conduct which could reasonably be considered inappropriate in a professional setting
-
-## Our Responsibilities
-
-Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
-
-Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
-
-## Scope
-
-This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
-
-## Enforcement
-
-Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [atom@github.com](mailto:atom@github.com). All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
-
-Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
-
-## Attribution
-
-This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]
-
-[homepage]: http://contributor-covenant.org
-[version]: http://contributor-covenant.org/version/1/4/
diff --git a/src/libs/lvgl/docs/CODING_STYLE.md b/src/libs/lvgl/docs/CODING_STYLE.md
deleted file mode 100644
index 46bc6375..00000000
--- a/src/libs/lvgl/docs/CODING_STYLE.md
+++ /dev/null
@@ -1,89 +0,0 @@
-# Coding style
-
-## File format
-Use [lv_misc/lv_templ.c](https://github.com/lvgl/lvgl/blob/master/src/lv_misc/lv_templ.c) and [lv_misc/lv_templ.h](https://github.com/lvgl/lvgl/blob/master/src/lv_misc/lv_templ.h)
-
-## Naming conventions
-* Words are separated by '_'
-* In variable and function names use only lower case letters (e.g. *height_tmp*)
-* In enums and defines use only upper case letters (e.g. *e.g. MAX_LINE_NUM*)
-* Global names (API):
- * starts with *lv*
- * followed by module name: *btn*, *label*, *style* etc.
- * followed by the action (for functions): *set*, *get*, *refr* etc.
- * closed with the subject: *name*, *size*, *state* etc.
-* Typedefs
- * prefer `typedef struct` and `typedef enum` instead of `struct name` and `enum name`
- * always end `typedef struct` and `typedef enum` type names with `_t`
-* Abbreviations:
- * Only words longer or equal than 6 characters can be abbreviated.
- * Abbreviate only if it makes the word at least half as long
- * Use only very straightforward and well-known abbreviations (e.g. pos: position, def: default, btn: button)
-
-## Coding guide
-* Functions:
- * Try to write function shorter than is 50 lines
- * Always shorter than 200 lines (except very straightforwards)
-* Variables:
- * One line, one declaration (BAD: char x, y;)
- * Use `<stdint.h>` (*uint8_t*, *int32_t* etc)
- * Declare variables where needed (not all at function start)
- * Use the smallest required scope
- * Variables in a file (outside functions) are always *static*
- * Do not use global variables (use functions to set/get static variables)
-
-## Comments
-Before every function have a comment like this:
-
-```c
-/**
- * Return with the screen of an object
- * @param obj pointer to an object
- * @return pointer to a screen
- */
-lv_obj_t * lv_obj_get_scr(lv_obj_t * obj);
-```
-
-Always use `/* Something */` format and NOT `//Something`
-
-Write readable code to avoid descriptive comments like:
-`x++; /* Add 1 to x */`.
-The code should show clearly what you are doing.
-
-You should write **why** have you done this:
-`x++; /*Because of closing '\0' of the string */`
-
-Short "code summaries" of a few lines are accepted. E.g. `/*Calculate the new coordinates*/`
-
-In comments use \` \` when referring to a variable. E.g. ``/*Update the value of `x_act`*/``
-
-### Formatting
-Here is example to show bracket placing and using of white spaces:
-```c
-/**
- * Set a new text for a label. Memory will be allocated to store the text by the label.
- * @param label pointer to a label object
- * @param text '\0' terminated character string. NULL to refresh with the current text.
- */
-void lv_label_set_text(lv_obj_t * label, const char * text)
-{ /* Main brackets of functions in new line*/
-
- if(label == NULL) return; /*No bracket only if the command is inline with the if statement*/
-
- lv_obj_inv(label);
-
- lv_label_ext_t * ext = lv_obj_get_ext(label);
-
- /*Comment before a section */
- if(text == ext->txt || text == NULL) { /*Bracket of statements start inline*/
- lv_label_refr_text(label);
- return;
- }
-
- ...
-}
-```
-
-Use 4 spaces indentation instead of tab.
-
-You can use **astyle** to format the code. Run `code-formatter.sh` from the `scrips` folder.
diff --git a/src/libs/lvgl/docs/CONTRIBUTING.md b/src/libs/lvgl/docs/CONTRIBUTING.md
deleted file mode 100644
index 553cfa51..00000000
--- a/src/libs/lvgl/docs/CONTRIBUTING.md
+++ /dev/null
@@ -1,5 +0,0 @@
-# Contributing to LVGL
-
-Thank you for considering contributing to LVGL.
-
-For a detailed description of contribution opportunities, please visit the [Contributing](https://docs.lvgl.io/latest/en/html/contributing/index.html) section of the documentation.
diff --git a/src/libs/lvgl/docs/ROADMAP.md b/src/libs/lvgl/docs/ROADMAP.md
deleted file mode 100644
index a606894f..00000000
--- a/src/libs/lvgl/docs/ROADMAP.md
+++ /dev/null
@@ -1,63 +0,0 @@
-# Roadmap
-
-This is a summary for thenew fatures of the major releases and a collection of ideas.
-
-This list indicates only the current intention and can be changed.
-
-## v8
-Planned to November/December 2020
-- Create an `lv_components` repository for compley widgets
- - It makes the core LVGL leaner
- - In `lv_components` we can have a lot and specific widgets
- - Good place for contribution
-- New scrolling:
- - See [feat/new-scroll](https://github.com/lvgl/lvgl/tree/feat/new-scroll) branch and [#1614](https://github.com/lvgl/lvgl/issues/1614)) issue.
- - Remove `lv_page` and support scrolling on `lv_obj`
- - 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
- - Already working
-- New layouts:
- - See [#1615](https://github.com/lvgl/lvgl/issues/1615) issue
- - [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
- - Remove `lv_cont` and support layouts on `lv_obj`
-- Simplified File system interface ([feat/new_fs_api](https://github.com/lvgl/lvgl/tree/feat/new-fs-api) branch) to make porting easier
- - Work in progress
-- Remove the align parameter from `lv_canvas_draw_text`
-- Make the copy parameter obsolate in create functions
-- 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)
-
-## 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
-
-## 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))
-- 9-patch support for `lv_imgbtn`.
-- Handle stride. See [#1858](https://github.com/lvgl/lvgl/issues/1858)
-- Make gradients more versatile
-- Make image transformations more versatile
-- Allow snapshoting object to tranfrom them to images
-
-## 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
-- Switch to RGBA colors in styles
-- 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)