Skip to content

Commit

Permalink
docs(quick-overview): clarify which folders are required (#6250)
Browse files Browse the repository at this point in the history
Co-authored-by: Liam <30486941+liamHowatt@users.noreply.github.com>
  • Loading branch information
kisvegabor and liamHowatt committed May 27, 2024
1 parent ba8642b commit 340fee4
Showing 1 changed file with 2 additions and 1 deletion.
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/lvgl.h``, ``lvgl/lv_version.h``, and ``lvgl/src``
for LVGL itself, and ``lvgl/examples`` and ``lvgl/demos`` for the examples and demos respectively.
- 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

0 comments on commit 340fee4

Please sign in to comment.