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: README.md
+17-3Lines changed: 17 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,4 +1,4 @@
1
-
# STMicroelectronics Secure Element Library (STSELib)
1
+
# ## STMicroelectronics Secure Element Library (STSELib)
2
2
3
3

4
4
@@ -19,7 +19,21 @@ Provides a set of product services that format all commands supported by the tar
19
19
<b>- Core layer</b>
20
20
Contains generic definition for ST Secure Element and functions for communicating with target secure element.
21
21
22
-
## Integration
22
+
# ## Package documentation
23
+
24
+
HTML documentation can either be downloaded as standalone package from the STSELib github repository [release section](https://github.com/STMicroelectronics/STSELib/releases)
25
+
or compiled from the library sources by executing following commands from the STSELib root directory:
26
+
27
+
```bash
28
+
cd Middleware/STSELib/doc/resources/
29
+
doxygen STSELib.doxyfile
30
+
```
31
+
32
+
> [!NOTE]
33
+
>
34
+
> Doxygen version 1.14.0 is required to build the documentation
35
+
36
+
# ## STSELib Integration
23
37
24
38
### 1. Add STSELib as a Git submodule
25
39
@@ -43,7 +57,7 @@ Two headers files are mantatories, [`stse_conf.h`](doc/resources/Markdown/03_LIB
43
57
For platform-specific integrations and STSafe use-cases, you may implement additional headers. Detailed specifications are available in the HTML documentation included in the release ZIP.
44
58
Reference implementation for most common STSE applicative use case can be found in section "Reference applicative examples" of this ReadMe file
45
59
46
-
## Reference applicative examples
60
+
### Reference applicative examples
47
61
48
62
Following applicative project can be used as reference for STSELib integration and usage.
0 commit comments