Embedded/lwshell
1
0
Fork 0
mirror of https://github.com/MaJerle/lwshell.git synced 2025-01-25 13:02:54 +08:00
Code Issues Projects Releases Wiki Activity

Improve documentation

Browse Source
This commit is contained in:
Tilen Majerle 2024-03-19 21:41:48 +01:00
parent 10d8249460
commit 6dc7a9d8fa
1 changed files with 1 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/get-started/index.rst
View File

@ -90,7 +90,7 @@ and it should be copied (or simply renamed in-place) and named ``lwshell_opts.h`
.. tip::
If you are using *CMake* build system, define the variable ``LWSHELL_OPTS_FILE`` before adding library's directory to the *CMake* project.
Variable must contain the path to the user options file. If not provided, one will be generated in the build directory.
Variable must contain the path to the user options file. If not provided and to avoid build error, one will be generated in the build directory.
Configuration options list is available available in the :ref:`api_lwshell_opt` section.
If any option is about to be modified, it should be done in configuration file