Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Examples: Update documentation #42

Merged
merged 1 commit into from
Dec 21, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 14 additions & 9 deletions examples/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,20 @@
A collection of applications that demonstrate the usage of SDS components.

## SDS Buffer
Example | Description
----------------------------------------------------------|-------------------------------
[SDS_Buffer](./sds_buffer/README.md) | Shows usage of SDS Buffer (Non-Blocking Read/Write to circular buffer)
Example | Description
------------------------------------------------------------------------------------|-------------------------------
[SDS Buffer](./sds_buffer/README.md) | Shows usage of SDS Buffer (Non-Blocking Read/Write to circular buffer)

## SDS Player
Example | Description
------------------------------------------------------------------------------------|-------------------------------
[SDS Player (FileSystem - Semihosting)](./sds_player/README.md) | Shows usage of SDS Player via File System (Semihosting)

## SDS Recorder
Example | Description
----------------------------------------------------------|-------------------------------
[SDS Recorder (FileSystem - FS_MDK)](./sds_recorder/fs/mdk/README.md/) | Shows usage of SDS Recorder via File System (Keil::File System)
Example | Description
------------------------------------------------------------------------------------|-------------------------------
[SDS Recorder (FileSystem - FS_MDK)](./sds_recorder/fs/mdk/README.md/) | Shows usage of SDS Recorder via File System (Keil::File System)
[SDS Recorder (FileSystem - Semihosting)](./sds_recorder/fs/semihosting/README.md/) | Shows usage of SDS Recorder via File System (Semihosting)
[SDS Recorder (Serial)](./sds_recorder/serial/usart/README.md/) | Shows usage of SDS Recorder via Serial Port (CMSIS Driver:USART)
[SDS Recorder (Socket)](./sds_recorder/socket/README.md/) | Shows usage of SDS Recorder via via Socket (IoT Utility:Socket)
[SDS Recorder (VCOM) ](./sds_recorder/vcom/mdk/README.md/) | Shows usage of SDS Recorder via USB Virtual COM Port (Keil::USB:Device:CDC)
[SDS Recorder (Serial)](./sds_recorder/serial/usart/README.md/) | Shows usage of SDS Recorder via Serial Port (CMSIS Driver:USART)
[SDS Recorder (Socket)](./sds_recorder/socket/README.md/) | Shows usage of SDS Recorder via via Socket (IoT Utility:Socket)
[SDS Recorder (VCOM) ](./sds_recorder/vcom/mdk/README.md/) | Shows usage of SDS Recorder via USB Virtual COM Port (Keil::USB:Device:CDC)
Loading