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(quick-overview): clarify which folders are required #6250

Merged
merged 2 commits into from
May 27, 2024
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion docs/get-started/quick-overview.rst
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,8 @@ If you would rather try LVGL on your own project follow these steps:

- `Download <https://github.com/lvgl/lvgl/archive/master.zip>`__ or
clone the library from GitHub with ``git clone https://github.com/lvgl/lvgl.git``.
- Copy the ``lvgl`` folder into your project.
- Copy the ``lvgl`` folder into your project. If you wish you can add only ``lvgl/src``
for LVGL itself, and ``lvgl/examples`` and ``lvgl/demos`` for the eaxmples and demos respectively.
kisvegabor marked this conversation as resolved.
Show resolved Hide resolved
- Copy ``lvgl/lv_conf_template.h`` as ``lv_conf.h`` next to the
``lvgl`` folder, change the first ``#if 0`` to ``1`` to enable the
file's content and set the :c:macro:`LV_COLOR_DEPTH` defines.
Expand Down
Loading