Skip to content

Commit e49a539

Browse files
committed
Update getting started
1 parent 939150d commit e49a539

File tree

1 file changed

+32
-15
lines changed

1 file changed

+32
-15
lines changed

docs/get-started/index.rst

Lines changed: 32 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -3,15 +3,21 @@
33
Getting started
44
===============
55

6+
Getting started may be the most challenging part of every new library.
7+
This guide is describing how to start with the library quickly and effectively
8+
69
.. _download_library:
710

811
Download library
912
^^^^^^^^^^^^^^^^
1013

1114
Library is primarly hosted on `Github <https://github.com/MaJerle/lwshell>`_.
1215

13-
* Download latest release from `releases area <https://github.com/MaJerle/lwshell/releases>`_ on Github
14-
* Clone `develop` branch for latest development
16+
You can get it with:
17+
18+
* Downloading latest release from `releases area <https://github.com/MaJerle/lwshell/releases>`_ on Github
19+
* Cloning ``master`` branch for latest stable version
20+
* Cloning ``develop`` branch for latest development
1521

1622
Download from releases
1723
**********************
@@ -24,7 +30,9 @@ Clone from Github
2430
First-time clone
2531
""""""""""""""""
2632

27-
* Download and install ``git`` if not already
33+
This is used when you do not have yet local copy on your machine.
34+
35+
* Make sure ``git`` is installed.
2836
* Open console and navigate to path in the system to clone repository to. Use command ``cd your_path``
2937
* Clone repository with one of available ``3`` options
3038

@@ -38,47 +46,56 @@ Update cloned to latest version
3846
"""""""""""""""""""""""""""""""
3947

4048
* Open console and navigate to path in the system where your resources repository is. Use command ``cd your_path``
41-
* Run ``git pull origin master --recurse-submodules`` command to pull latest changes and to fetch latest changes from submodules
49+
* Run ``git pull origin master --recurse-submodules`` command to pull latest changes and to fetch latest changes from submodules on ``master`` branch
50+
* Run ``git pull origin develop --recurse-submodules`` command to pull latest changes and to fetch latest changes from submodules on ``develop`` branch
4251
* Run ``git submodule foreach git pull origin master`` to update & merge all submodules
4352

4453
.. note::
45-
This is preferred option to use when you want to evaluate library and run prepared examples.
46-
Repository consists of multiple submodules which can be automatically downloaded when cloning and pulling changes from root repository.
54+
This is preferred option to use when you want to evaluate library and run prepared examples.
55+
Repository consists of multiple submodules which can be automatically downloaded when cloning and pulling changes from root repository.
4756

4857
Add library to project
4958
^^^^^^^^^^^^^^^^^^^^^^
5059

5160
At this point it is assumed that you have successfully download library, either cloned it or from releases page.
61+
Next step is to add the library to the project, by means of source files to compiler inputs and header files in search path
5262

53-
* Copy ``lwshell`` folder to your project
54-
* Add ``lwshell/src/include`` folder to `include path` of your toolchain
55-
* Add source files from ``lwshell/src/`` folder to toolchain build
63+
* Copy ``lwshell`` folder to your project, it contains library files
64+
* Add ``lwshell/src/include`` folder to `include path` of your toolchain. This is where `C/C++` compiler can find the files during compilation process. Usually using ``-I`` flag
65+
* Add source files from ``lwshell/src/`` folder to toolchain build. These files are built by `C/C++` compiler
5666
* Copy ``lwshell/src/include/lwshell/lwshell_opts_template.h`` to project folder and rename it to ``lwshell_opts.h``
5767
* Build the project
5868

5969
Configuration file
6070
^^^^^^^^^^^^^^^^^^
6171

72+
Configuration file is used to overwrite default settings defined for the essential use case.
6273
Library comes with template config file, which can be modified according to needs.
63-
This file shall be named ``lwshell_opts.h`` and its default template looks like the one below.
74+
and it should be copied (or simply renamed in-place) and named ``lwshell_opts.h``
6475

6576
.. note::
6677
Default configuration template file location: ``lwshell/src/include/lwshell/lwshell_opts_template.h``.
67-
File must be renamed to ``lwshell_opts.h`` first and then copied to the project directory (or simply renamed in-place) where compiler
78+
File must be renamed to ``lwshell_opts.h`` first and then copied to the project directory where compiler
6879
include paths have access to it by using ``#include "lwshell_opts.h"``.
6980

70-
.. tip::
71-
Check :ref:`api_lwshell_opt` section for possible configuration settings
81+
List of configuration options are available in the :ref:`api_lwshell_opt` section.
82+
If any option is about to be modified, it should be done in configuration file
7283

7384
.. literalinclude:: ../../lwshell/src/include/lwshell/lwshell_opts_template.h
7485
:language: c
7586
:linenos:
76-
:caption: Template options file
87+
:caption: Template configuration file
88+
89+
.. note::
90+
If you prefer to avoid using configuration file, application must define
91+
a global symbol ``LWSHELL_IGNORE_USER_OPTS``, visible across entire application.
92+
This can be achieved with ``-D`` compiler option.
7793

7894
Minimal example code
7995
^^^^^^^^^^^^^^^^^^^^
8096

81-
Run below example to test and verify library
97+
To verify proper library setup, minimal example has been prepared.
98+
Run it in your main application file to verify its proper execution
8299

83100
.. literalinclude:: ../examples_src/example_minimal.c
84101
:language: c

0 commit comments

Comments
 (0)