Temporary inclusion of ui folder to allow folder structure commit

Updated README to better explain folder structure
This commit is contained in:
andrew 2020-11-16 11:07:38 +00:00
parent c3edd9442a
commit 8760b98d19
3 changed files with 10 additions and 2 deletions

2
.gitignore vendored
View File

@ -2,7 +2,7 @@
build/ build/
# Ignore UI folder, this should be commited in its own repository # Ignore UI folder, this should be commited in its own repository
ui/
# Ignore all dot folders, with below exceptions # Ignore all dot folders, with below exceptions
.*/ .*/

View File

@ -34,6 +34,8 @@ sudo apt-get update && sudo apt-get install -y build-essential libsdl2-dev
``` ```
### Setup ### Setup
Configure lv_conf.h to suit your project, place your UI code in the UI folder and edit main/src/main.c to call you UI entry function. To build and debug, press F5. You should now have your UI displayed in a new window and can access all the debug features of VSCode through GDB. To allow custom UI code an `lv_conf.h` file placed at `ui/simulator/inc` will automatically override this projects lv_conf.h file. By default code under `ui` is ignored so you can reuse this repository for multiple projects. You will need to place a call from `main.c` to your UI's entry function.
To build and debug, press F5. You should now have your UI displayed in a new window and can access all the debug features of VSCode through GDB.
To allow temporary modification between simulator and device code, a SIMULATOR=1 define is added globally. To allow temporary modification between simulator and device code, a SIMULATOR=1 define is added globally.

6
ui/simulator/README Normal file
View File

@ -0,0 +1,6 @@
## Simulator
As most projects are targetted at embedded devices, this folder is for simulator specfic code to allow the UI to run on a desktop environment.
lv_conf.h placed in ui/simulator/inc will automatically override the main lv_conf.h, to allow project specific settings without modifying the lv_sim_vscode project