Developer Services template project

TODO Put project introduction here. 1-2 sentence about the project.

How to use the template

1. Import the basic ruleset. Follow the official GitHub guide. 2. Update if necessary the issue_templates and the pull request template 3. Create your sw projects under projects/ folder. 4. Check .gitignore file and modify it if it is necessary 5. Check the ./Dockerfile and extend it if necessary 6. Make sure that the whole project can be compiled with a single "make all" command. also implement "make clean" 7. Fill out the CODEOWNERS file. Here is the official github guide 8. Add github app private key for CLA assistant signature. Contact silicon labs github support person for it. 9. Check the available workflows and adjust them according to the repo types (internal or public) 10. Update this Readme file and remove this list from it.

Hardware requirements

TODO List the required hw components.

Hardware Setup

TODO Create a block diagram about the components.

Build environment setup

TODO Add steps here how to create a build environment. Remove the not supported platforms.

Docker

Using Docker for the build environment has several advantages: - Consistency: Ensures the build environment is the same across all development machines. - Isolation: Keeps the build environment isolated from the host machine, avoiding conflicts. - Portability: Allows the build environment to be easily shared and reproduced. - Scalability: Simplifies scaling the build process across multiple machines.

To set up the Docker-based build environment, follow these steps:
1. Install Docker on your machine. Only Linux and MacOS platforms are supported for now.
2. Clone the repository.
3. Build the Docker image using the provided Dockerfile.
4. Run the Docker container with the necessary configurations.

Windows

TODO With a numbered list define the process how to set up a development environment.

Linux

TODO With a numbered list define the process how to set up a development environment.

MacOS

TODO With a numbered list define the process how to set up a development environment.

Debug environment

TODO Explain how can a developer debug this software project. Pictures are recommended.

Contributing

Please follow the CONTRIBUTING guideline.

License

See the LICENSE.md file for details.

Secrets

TODO List here the necessary secrets. DO NOT USE PERSONAL ACCESS TOKENS IN PUBLIC REPOSITORIES.