Skip to content

Commit 6700820

Browse files
committed
doc(README.md): updated compatibility table, fixed libtropic styling.
1 parent cf1dbab commit 6700820

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# libtropic
1+
# Libtropic
22

33
![](https://github.com/tropicsquare/libtropic/actions/workflows/integration_tests.yml/badge.svg) ![](https://github.com/tropicsquare/libtropic/actions/workflows/build_docs_master.yml/badge.svg) ![](https://tropic-gitlab.corp.sldev.cz/internal/sw-design/libtropic/badges/master/coverage.svg)
44

@@ -11,19 +11,19 @@ Libtropic documentation is available [here](https://tropicsquare.github.io/libtr
1111

1212
## Compatibility with TROPIC01 firmware versions
1313

14-
For the `libtropic` library to function correctly with the TROPIC01 secure element, the versions of three key components must be compatible:
14+
For the Libtropic library to function correctly with the TROPIC01 secure element, the versions of three key components must be compatible:
1515

16-
1. **`libtropic` SDK**: The version of this library.
16+
1. **Libtropic SDK**: The version of this library.
1717
2. **Application Firmware**: The main firmware running on the TROPIC01 chip.
1818
3. **SPECT Firmware**: The co-processor firmware on the TROPIC01 chip.
1919

2020
The following table outlines the tested and supported compatibility between released versions:
2121

22-
| API document version | `libtropic` | Application | SPECT | Bootloader | Tests |
23-
| :----------------------------------------------------------------------------------------------------: |:-------------------:|:----------------------:|:----------------:| :-------: | :---------------------------------------: |
24-
| [1.3.0](https://github.com/tropicsquare/tropic01/blob/main/doc/api/ODU_TR01_user_api_v1.3.0.pdf) | 1.0.0 | 1.0.0 | 1.0.0 | v1.0.1 | <code style="color : green">Passed</code> |
25-
| [1.3.0](https://github.com/tropicsquare/tropic01/blob/main/doc/api/ODU_TR01_user_api_v1.3.0.pdf) | 1.0.0, 2.0.0, 2.0.1 | 1.0.0 | 1.0.0 | v2.0.1 | <code style="color : green">Passed</code> |
26-
| [1.3.0](https://github.com/tropicsquare/tropic01/blob/main/doc/api/ODU_TR01_user_api_v1.3.0.pdf) | 2.0.1 | 1.0.1 | 1.0.0 | v2.0.1 | <code style="color : green">Passed</code> |
22+
| Libtropic | Application | SPECT | Bootloader | Tests | API document version |
23+
|:-------------------:|:----------------------:|:----------------:| :-------: | :---------------------------------------: | :----------------------------------------------------------------------------------------------------: |
24+
| 1.0.0 | 1.0.0 | 1.0.0 | v1.0.1 | <code style="color : green">Passed</code> | [1.3.0](https://github.com/tropicsquare/tropic01/blob/main/doc/api/ODU_TR01_user_api_v1.3.0.pdf) |
25+
| 2.0.0 | 1.0.0–1.0.1 | 1.0.0 | v2.0.1 | <code style="color : green">Passed</code> | [1.3.0](https://github.com/tropicsquare/tropic01/blob/main/doc/api/ODU_TR01_user_api_v1.3.0.pdf) |
26+
| 2.0.1 | 1.0.0–1.0.1 | 1.0.0 | v2.0.1 | <code style="color : green">Passed</code> | [1.3.0](https://github.com/tropicsquare/tropic01/blob/main/doc/api/ODU_TR01_user_api_v1.3.0.pdf) |
2727

2828
Using mismatched versions of the components may result in unpredictable behavior or errors. It is strongly advised to use the latest compatible versions of all components to ensure proper functionality.
2929

0 commit comments

Comments
 (0)