You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/get-started/index.rst
+32-15Lines changed: 32 additions & 15 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,15 +3,21 @@
3
3
Getting started
4
4
===============
5
5
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
+
6
9
.. _download_library:
7
10
8
11
Download library
9
12
^^^^^^^^^^^^^^^^
10
13
11
14
Library is primarly hosted on `Github <https://github.com/MaJerle/lwshell>`_.
12
15
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
15
21
16
22
Download from releases
17
23
**********************
@@ -24,7 +30,9 @@ Clone from Github
24
30
First-time clone
25
31
""""""""""""""""
26
32
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.
28
36
* Open console and navigate to path in the system to clone repository to. Use command ``cd your_path``
29
37
* Clone repository with one of available ``3`` options
30
38
@@ -38,47 +46,56 @@ Update cloned to latest version
38
46
"""""""""""""""""""""""""""""""
39
47
40
48
* 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
42
51
* Run ``git submodule foreach git pull origin master`` to update & merge all submodules
43
52
44
53
.. 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.
47
56
48
57
Add library to project
49
58
^^^^^^^^^^^^^^^^^^^^^^
50
59
51
60
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
52
62
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
56
66
* Copy ``lwshell/src/include/lwshell/lwshell_opts_template.h`` to project folder and rename it to ``lwshell_opts.h``
57
67
* Build the project
58
68
59
69
Configuration file
60
70
^^^^^^^^^^^^^^^^^^
61
71
72
+
Configuration file is used to overwrite default settings defined for the essential use case.
62
73
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``
0 commit comments