Skip to content

Commit 3417b48

Browse files
Evagan2018Evagan2018
committed
Updated READMEl.md file. Added Quick Start, Examples, and Continuous Integration (CI) section. Updated .gitignore file.
1 parent 54ffed9 commit 3417b48

File tree

2 files changed

+138
-21
lines changed

2 files changed

+138
-21
lines changed

‎.gitignore‎

Lines changed: 83 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,83 @@
1-
build
2-
output
3-
site
4-
docs
5-
linkchecker-out.csv
1+
# Prerequisites
2+
*.d
3+
4+
# Object files
5+
*.o
6+
*.ko
7+
*.obj
8+
*.elf
9+
10+
# Linker output
11+
*.ilk
12+
*.map
13+
*.exp
14+
15+
# Precompiled Headers
16+
*.gch
17+
*.pch
18+
19+
# Libraries
20+
*.lib
21+
*.a
22+
*.la
23+
*.lo
24+
25+
# Shared objects (inc. Windows DLLs)
26+
*.dll
27+
*.so
28+
*.so.*
29+
*.dylib
30+
31+
# Executables
32+
*.exe
33+
*.out
34+
*.app
35+
*.i*86
36+
*.x86_64
37+
*.hex
38+
39+
# Debug files
40+
*.dSYM/
41+
*.su
42+
*.idb
43+
*.pdb
44+
45+
# Kernel Module Compile Results
46+
*.mod*
47+
*.cmd
48+
.tmp_versions/
49+
modules.order
50+
Module.symvers
51+
Mkfile.old
52+
dkms.conf
53+
54+
# Clangd
55+
.clangd
56+
57+
# uv2csolution generated log file
58+
uv2csolution.log
59+
60+
# CMSIS Solution files and folders not to be tracked
61+
# default directory of build artifacts
62+
**/out
63+
# directory containing intermediate files to be regenerated
64+
**/tmp
65+
66+
# Update config files must be merged before commit
67+
*.update@*
68+
69+
# cbuild output files
70+
*.cbuild.yml
71+
*.cbuild-idx.yml
72+
*.cbuild-run.yml
73+
*.cbuild-set.yml
74+
75+
# .vscode JSON and debug adapter files generated by CMSIS Solution
76+
.vscode/cmsis.json
77+
.vscode/launch.json
78+
.vscode/tasks.json
79+
.vscode/settings.json
80+
.cmd.jlink
81+
82+
# legacy intermediate project file
83+
*.cprj

‎README.md‎

Lines changed: 55 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,43 +1,82 @@
1+
[![License](https://img.shields.io/github/license/arm-software/SDS-Framework?label)](https://github.com/ARM-software/SDS-Framework/blob/main/LICENSE)
2+
[![Pack](https://img.shields.io/github/actions/workflow/status/Arm-Software/SDS-Framework/pack.yml?logo=arm&logoColor=0091bd&label=Build%20pack)](./.github/workflows/pack.yml)
3+
[![GH-Pages](https://img.shields.io/github/actions/workflow/status/Arm-Software/SDS-Framework/gh-pages.yml?logo=arm&logoColor=0091bd&label=Deploy%20content)](./.github/workflows/gh-pages.yml)
4+
[![Build examples](https://img.shields.io/github/actions/workflow/status/Arm-Software/SDS-Framework/build_examples.yml?logo=arm&logoColor=0091bd&label=Build%20examples)](./.github/workflows/build_examples.yml)
5+
16
# SDS Framework
27

38
The **Synchronous Data Stream (SDS) Framework** implements a data stream management, provides methods and helper tools for developing and optimizing embedded applications that integrate DSP and ML algorithms. This framework may be used stand-alone, but also in combination with [**CMSIS-Stream**](https://github.com/ARM-software/CMSIS-Stream) that allows to combine algorithms using a compute graph.
49

5-
Refer to [Overview](./overview/README.md) for more details.
610

7-
## Repository structure
11+
## Quick Start
12+
13+
1. Install [Keil Studio for VS Code](https://marketplace.visualstudio.com/items?itemName=Arm.keil-studio-pack) from the VS Code marketplace.
14+
2. Clone this repository (for example using [Git in VS Code](https://code.visualstudio.com/docs/sourcecontrol/intro-to-git)) or download the ZIP file. Then open the base folder in VS Code.
15+
3. Open the [CMSIS View](https://mdk-packs.github.io/vscode-cmsis-solution-docs/userinterface.html#2-main-area-of-the-cmsis-view) in VS Code and use the ... menu to choose an example via *Select Active Solution from workspace*.
16+
4. The related tools and software packs are downloaded and installed. Review progress with *View - Output - CMSIS Solution*.
17+
5. In the CMSIS view, use the [Action buttons](https://github.com/ARM-software/vscode-cmsis-csolution?tab=readme-ov-file#action-buttons) to build, load and debug the example on the hardware.
18+
19+
20+
## Examples
21+
22+
The [SDS template application](https://arm-software.github.io/SDS-Framework/main/template.html) demonstarte the recording and playback of real-world data streams using physical hardware or simulation via [Arm Virtual Hardware - FVP](https://github.com/ARM-software/AVH). Simulation enables cost-effective, automated regression testing on desktops or in cloud-based CI/MLOps pipelines. The real-world data streams are captured in [SDS data files](https://arm-software.github.io/SDS-Framework/main/theory.html#sds-data-files).
23+
24+
Refer to [Overview](./overview/README.md) for more details.
825

9-
Directory | Description
10-
----------------------------------|-------------------------------
11-
[overview](./overview) | Top-level overview of SDS Framework.
12-
[documentation](./documentation/) | [User documentation](https://arm-software.github.io/SDS-Framework/main/index.html) of the SDS Framework.
13-
[template](./template) | [SDS template application](https://arm-software.github.io/SDS-Framework/main/template.html), a test framework for DSP and ML algorithms.
14-
[layer/sdsio](./layer/sdsio) | Configured [SDSIO layers](https://arm-software.github.io/SDS-Framework/main/sdsio.html) for file I/O via Network, USB, or File System.
15-
[utilities](./utilities) | Python scripts for processing of SDS binary data files.
16-
[schema](./schema) | Schema for [SDS YAML metadata format](https://arm-software.github.io/SDS-Framework/main/theory.html#yaml-metadata-format) that describes the content of SDS files.
17-
[sds](./sds) | SDS-Framework source files and implementation of various SDSIO interfaces.
18-
[.github/workflows](./.github/workflows) | GitHub Actions for validation and publishing.
19-
[.ci](./.ci) | Files that relate to CI tests.
2026

2127
## Related
2228

23-
- [SDS Pack](https://www.keil.arm.com/packs/sds-arm) available on [keil.arm.com/packs](https://www.keil.arm.com/packs).
24-
- [SDS Examples](https://github.com/Arm-Examples/sds-examples) a repository with SDS template applications that are configured for evaluation boards and use cases.
29+
- The [SDS Pack](https://www.keil.arm.com/packs/sds-arm) is available on [keil.arm.com/packs](https://www.keil.arm.com/packs).
30+
- The [SDS Examples](https://github.com/Arm-Examples/sds-examples) is a repository with SDS examples configured for various Evaluation Boards and use the [MDK-Middleware](https://www.keil.arm.com/packs/mdk-middleware-keil/overview/) for the[SDSIO Interface](https://arm-software.github.io/SDS-Framework/main/sdsio.html).
2531
- [ML Developers Guide for Cortex-M Processors and Ethos-U NPU](https://developer.arm.com/documentation/109267).
2632
- [Arm Virtual Hardware - FVP](https://github.com/arm-software/avh) repository with documentation.
2733

34+
35+
## Files and Directories
36+
37+
This is a list of the relevant files and directories.
38+
39+
| Directory | Description |
40+
|--- |--- |
41+
| [overview](./overview) | Top-level overview of SDS Framework. |
42+
| [documentation](./documentation/) | [User documentation](https://arm-software.github.io/SDS-Framework/main/index.html) of the SDS Framework. |
43+
| [template](./template) | [SDS template application](https://arm-software.github.io/SDS-Framework/main/template.html), a test framework for DSP and ML algorithms. |
44+
| [layer/sdsio](./layer/sdsio) | Configured [SDSIO layers](https://arm-software.github.io/SDS-Framework/main/sdsio.html) for file I/O via Network, USB, or File System. |
45+
| [utilities](./utilities) | Python scripts for processing of SDS binary data files. |
46+
| [schema](./schema) | Schema for [SDS YAML metadata format](https://arm-software.github.io/SDS-Framework/main/theory.html#yaml-metadata-format) that describes the content of SDS files. |
47+
| [sds](./sds) | SDS-Framework source files and implementation of various SDSIO interfaces. |
48+
| [.github/workflows](./.github/workflows) | GitHub Actions for validation and publishing. |
49+
| [.ci](./.ci) | Files that relate to CI tests. |
50+
51+
52+
## Continuous Integration (CI)
53+
54+
The underlying build system of [Keil Studio](https://www.keil.arm.com/) uses the [CMSIS-Toolbox](https://open-cmsis-pack.github.io/cmsis-toolbox/) and CMake. [CI](https://en.wikipedia.org/wiki/Continuous_integration) is effectively supported with:
55+
- Tool installation based on a single [`vcpkg-configuration.json`](./vcpkg-configuration.json) file for desktop and CI environments.
56+
- CMSIS solution files (`*.csolution.yml`) that enable seamless builds in CI, for example using GitHub actions.
57+
58+
| CI Workflow | Description |
59+
|--- |--- |
60+
| [pack](./.github/workflows/pack.yml) | Builds the pack on a GitHub hosted runner. |
61+
| [gh-pages](./.github/workflows/gh-pages.yml) | Deploying this content to GitHub Pages. |
62+
| [build_examples](./.github/workflows/build_examples.yml) | Builds the application binaries by using the Arm Compiler for Embedded (AC6) on a GitHub hosted runner. |
63+
64+
2865
## License
2966

3067
The SDS Framework is licensed under [![License](https://img.shields.io/github/license/arm-software/sds-framework?label)](https://github.com/ARM-software/sds-framework/blob/main/LICENSE).
3168

69+
3270
## Documentation
3371

34-
The [documentation](https://arm-software.github.io/SDS-Framework/main/index.html) is generated using [Doxygen](https://www.doxygen.nl/) and [MKDocs](https://www.mkdocs.org/) with the following additional plugins:
72+
The [documentation](https://arm-software.github.io/SDS-Framework/main/index.html) is generated by using [Doxygen](https://www.doxygen.nl/) and [MKDocs](https://www.mkdocs.org/) with the following additional plugins:
3573

3674
- [mermaid2](https://mkdocs-mermaid2.readthedocs.io/en/latest/) for sequence diagrams.
3775
- [mkdoxy](https://pypi.org/project/mkdoxy) for API documentation.
3876

3977
Use `mkdocs serve` to generate the documentation on a local computer.
4078

79+
4180
## Contributions and Pull Requests
4281

4382
Contributions are accepted under [![License](https://img.shields.io/github/license/arm-software/CMSIS_6?label)](https://github.com/ARM-software/CMSIS_6/blob/main/LICENSE). Only submit contributions where you have authored all of the code.

0 commit comments

Comments
 (0)