Skip to content

Commit

Permalink
Update docs getting started
Browse files Browse the repository at this point in the history
  • Loading branch information
MaJerle committed Jul 9, 2020
1 parent 85a8602 commit 571e44e
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 4 deletions.
6 changes: 3 additions & 3 deletions docs/api-reference/opt.rst
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
.. _api_lwow_opt:

LwOW configuration
==================
Configuration
=============

This is the default configuration of the middleware.
When any of the settings shall be modified, it shall be done in dedicated application config ``lwow_opts.h`` file.

.. note::
Check :ref:`getting_started` to create configuration file.
Check :ref:`getting_started` for guidelines on how to create and use configuration file.

.. doxygengroup:: LWOW_OPT
7 changes: 6 additions & 1 deletion docs/get-started/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,12 @@ Configuration file
^^^^^^^^^^^^^^^^^^

Library comes with template config file, which can be modified according to needs.
This file shall be named ``lwow_opts.h`` and its default template looks like the one below:
This file shall be named ``lwow_opts.h`` and its default template looks like the one below.

.. note::
Default configuration template file location: ``lwow/src/include/lwow/lwow_opts_template.h``.
File must first be renamed to ``lwow_opts.h`` and then copied to the project directory (or simply renamed in-place) where compiler
include paths have access to it by using ``#include "lwow_opts.h"``.

.. tip::
Check :ref:`api_lwow_opt` section for possible configuration settings
Expand Down

0 comments on commit 571e44e

Please sign in to comment.