Skip to content

Commit d44756c

Browse files
authoredJan 17, 2025··
Update README with notes about safe and unsafe bindings (#187)
* Update README with notes about safe and unsafe bindings * Update build command for embedded Remove $ from command Add missing space in embedded builds * README: Add note about enum issue when compiling with GCC Fixes #163
1 parent 9e8dddb commit d44756c

File tree

1 file changed

+12
-1
lines changed

1 file changed

+12
-1
lines changed
 

‎README.md

+12-1
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ for `no_std`, so we need to use a workaround to build "lvgl-rs". The mainstrem i
6060
[rust-lang/cargo#7915](https://github.com/rust-lang/cargo/issues/7915).
6161

6262
```shell
63-
$ DEP_LV_CONFIG_PATH=`pwd` cargo build -Zfeatures=build_dep
63+
DEP_LV_CONFIG_PATH=`pwd` cargo build -Z features=build_dep
6464
```
6565

6666
The `unsafe_no_autoinit` feature must also be enabled when building for baremetal targets. See its documentation in `Cargo.toml` for notes on usage.
@@ -99,6 +99,10 @@ $ DEP_LV_CONFIG_PATH=`pwd`/examples/include cargo run --example demo --features=
9999
The bindings are still in development. There are many features of LVGL that needs to be exposed by `lvgl-rs`. In
100100
this section you can check what is implemented at the moment.
101101

102+
Unsafe bindings are located in `lvgl-sys` folder are generated via `bindgen`.
103+
104+
Safe bindings are generated using the `lvgl-codegen` lib, which takes the raw unsafe bindings and generate safe/rust idiomatic bindings (check the `build.rs` script in the `lvgl` folder).
105+
102106
### Features
103107

104108
List of LVGL features that impacts the library usage in general.
@@ -123,4 +127,11 @@ List of LVGL features that impacts the library usage in general.
123127
Widgets currently implemented might have some missing features. If the widget you want to use is not exposed or
124128
is missing a feature you want to make use, please send a Pull Request or open an issue.
125129

130+
### Troubleshooting
131+
132+
Here's a list of known issues that can be faced when using this repo:
133+
134+
- [Enum alignment issues](https://github.com/lvgl/lv_binding_rust/issues/163)
135+
136+
126137
[![SWUbanner](https://raw.githubusercontent.com/vshymanskyy/StandWithUkraine/main/banner2-direct.svg)](https://github.com/vshymanskyy/StandWithUkraine/blob/main/docs/README.md)

0 commit comments

Comments
 (0)
Please sign in to comment.