Skip to content

Commit d7f781e

Browse files
authored
[Doc] Add doc building steps to ReadMe.md
1 parent ff70e6d commit d7f781e

File tree

1 file changed

+17
-3
lines changed

1 file changed

+17
-3
lines changed

README.md

Lines changed: 17 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# STMicroelectronics Secure Element Library (STSELib)
1+
# ## STMicroelectronics Secure Element Library (STSELib)
22

33
![STSELib](doc/resources/Pictures/STSELib.png)
44

@@ -19,7 +19,21 @@ Provides a set of product services that format all commands supported by the tar
1919
<b>- Core layer</b>
2020
Contains generic definition for ST Secure Element and functions for communicating with target secure element.
2121

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
2337

2438
### 1. Add STSELib as a Git submodule
2539

@@ -43,7 +57,7 @@ Two headers files are mantatories, [`stse_conf.h`](doc/resources/Markdown/03_LIB
4357
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.
4458
Reference implementation for most common STSE applicative use case can be found in section "Reference applicative examples" of this ReadMe file
4559

46-
## Reference applicative examples
60+
# ## Reference applicative examples
4761

4862
Following applicative project can be used as reference for STSELib integration and usage.
4963

0 commit comments

Comments
 (0)