Skip to content

Commit 726a9df

Browse files
committed
docs: fix markdown lint issues
1 parent a4254eb commit 726a9df

File tree

2 files changed

+8
-2
lines changed

2 files changed

+8
-2
lines changed

README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -57,26 +57,32 @@ Instead of storing log strings on your embedded device, Trice keeps them on your
5757
## When to Use Trice
5858

5959
### Logging and Debugging
60+
6061
You can use Trice for `printf` debugging and as a logging system. The advantage is very short messages (no strings) for data transfer. Remember that the file [til.json](./demoTIL.json) is needed to read all output from devices in the field for 10+ years.
6162

6263
- **Optional:** Add [til.json](./demoTIL.json) as a compressed resource to your target image. You can use [SRecord](http://srecord.sourceforge.net/download.html) or provide a download link.
6364

6465
### Data Compression
66+
6567
Trice looks like data compression (IDs instead of strings), which is useful for [IoT](https://en.wikipedia.org/wiki/Internet_of_things) devices, especially [NB-IoT](https://en.wikipedia.org/wiki/Narrowband_IoT) with very low data rates.
6668

6769
### FLASH Memory Storage
70+
6871
[Store Trice messages in FLASH memory](./docs/TriceUserManual.md#writing-the-trice-logs-into-an-sd-card-(or-a-user-specific-output)) for later analysis. A typical `trice` uses only 4 bytes, no matter how long the format string is.
6972

7073
### Encryption
74+
7175
You can **encrypt** Trice transfer packets for security.
7276

7377
- Deliver firmware images with encrypted Trice output that only works with the right key and [til.json](./demoTIL.json)
7478
- [XTEA](https://en.m.wikipedia.org/wiki/XTEA) encryption is available
7579

7680
### Translation
81+
7782
Translate the [til.json](./demoTIL.json) file into **different languages**. Change the language by changing the [til.json](./demoTIL.json) file without changing the target binary.
7883

7984
### Timing Analysis
85+
8086
Trice makes **timing analysis** easy on distributed embedded systems. It supports both host and target timestamps.
8187

8288
## How Trice Works (UART Example)

docs/TriceUserManual_AI_reworked_NOT_reviewed.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -454,7 +454,7 @@ This is the fastest path if you have a Segger J-Link and can use RTT:
454454

455455
4. **Insert IDs and build**
456456
* Run `trice insert` (or `trice i ...`), then build your firmware.
457-
See: [Insert IDs](#insert-ids).
457+
<!-- See: [Insert IDs](#insert-ids). -->
458458

459459
5. **View logs via RTT**
460460
* Start the Trice host tool and connect via RTT.
@@ -475,7 +475,7 @@ Use this if you have a serial port connected to your target (or a USB CDC ACM po
475475

476476
4. **View logs via UART**
477477
* Start `trice log` and connect to the COM/tty port.
478-
See: [Trice tool in logging action](#trice-tool-in-logging-action) and [Trice tool CLI usage examples](#trice-tool-cli-usage-examples).
478+
See: [Trice tool in logging action](#trice-tool-in-logging-action). <!-- and [Trice tool CLI usage examples](#trice-tool-cli-usage-examples). -->
479479

480480
### 1.3. <a id='where-to-go-next'></a>Where to go next
481481

0 commit comments

Comments
 (0)