Skip to content

Commit 2ed4f83

Browse files
committed
clean up repo and remove template items
1 parent 80d425f commit 2ed4f83

File tree

6 files changed

+8
-183
lines changed

6 files changed

+8
-183
lines changed

.github/CODEOWNERS

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
11
# This is a # Default codeowners for the repository
2-
* @SiliconLabsSoftware/devservices-admins
2+
* @SiliconLabsSoftware/techpubs

.gitignore

Lines changed: 4 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -16,17 +16,7 @@
1616
**/IAR ARM*
1717
**/sonar-bw/
1818

19-
##Enable these if you are not tracking Simplicity studio project
20-
# **/.cproject
21-
# **/.project
22-
# **/.pdm
23-
24-
## Documentation related ignores.
25-
## Modify them if it is necessary
26-
*.docx
27-
*.doc
28-
*.ppt
29-
*.pdf
30-
*.xlsx
31-
*.xls
32-
*.html
19+
#Enable these if you are not tracking Simplicity studio project
20+
**/.cproject
21+
**/.project
22+
**/.pdm

Dockerfile

Lines changed: 0 additions & 101 deletions
This file was deleted.

README.md

Lines changed: 3 additions & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -1,56 +1,8 @@
1-
# Developer Services template project
2-
** TODO ** Put project introduction here. 1-2 sentence about the project.
3-
## How to use the template
4-
1. Import the [basic ruleset](https://github.com/SiliconLabsSoftware/devs-template/blob/main/.github/rulesets/Silabs-basic-public-ruleset.json). Follow the official GitHub [guide](https://docs.github.com/en/enterprise-cloud@latest/organizations/managing-organization-settings/managing-rulesets-for-repositories-in-your-organization#importing-a-ruleset).
5-
2. Update if necessary the [issue_templates](.github/ISSUE_TEMPLATE/) and the [pull request template](./.github/PULL_REQUEST_TEMPLATE.md)
6-
3. Create your sw projects under [projects/](projects/) folder.
7-
4. Check [.gitignore](.gitignore) file and modify it if it is necessary
8-
5. Check the [./Dockerfile](./Dockerfile) and extend it if necessary
9-
6. Make sure that the whole project can be compiled with a single "make all" command.
10-
also implement "make clean"
11-
7. Fill out the [CODEOWNERS](./.github/CODEOWNERS) file. Here is the official github [guide](https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners)
12-
8. Add github app private key for CLA assistant signature. Contact silicon labs github support person for it.
13-
9. Check the available [workflows](./.github/workflows) and adjust them according to the repo types (internal or public)
14-
10. Update this Readme file and remove this list from it.
1+
# Silicon Labs Matter Documentation
2+
This project contains source Markdown files for the Silicon Labs Matter [documentation](https://docs.silabs.com/matter/latest).
153

16-
## Hardware requirements
17-
** TODO ** List the required hw components.
18-
19-
## Hardware Setup
20-
** TODO ** Create a block diagram about the components.
21-
22-
## Build environment setup
23-
** TODO ** Add steps here how to create a build environment. Remove the not supported platforms.
24-
### Docker
25-
Using Docker for the build environment has several advantages:
26-
- **Consistency**: Ensures the build environment is the same across all development machines.
27-
- **Isolation**: Keeps the build environment isolated from the host machine, avoiding conflicts.
28-
- **Portability**: Allows the build environment to be easily shared and reproduced.
29-
- **Scalability**: Simplifies scaling the build process across multiple machines.
30-
31-
To set up the Docker-based build environment, follow these steps:
32-
1. Install Docker on your machine. Only Linux and MacOS platforms are supported for now.
33-
2. Clone the repository.
34-
3. Build the Docker image using the provided [Dockerfile](./Dockerfile).
35-
4. Run the Docker container with the necessary configurations.
36-
37-
### Windows
38-
** TODO ** With a numbered list define the process how to set up a development environment.
39-
40-
### Linux
41-
** TODO ** With a numbered list define the process how to set up a development environment.
42-
43-
### MacOS
44-
** TODO ** With a numbered list define the process how to set up a development environment.
45-
46-
## Debug environment
47-
**TODO**
48-
Explain how can a developer debug this software project. Pictures are recommended.
494
## Contributing
50-
Please follow the [CONTRIBUTING](./.github/CONTRIBUTING.md) guideline.
5+
Please follow the [CONTRIBUTING](./.github/CONTRIBUTING.md) guidelines.
516

527
## License
538
See the [LICENSE.md](./LICENSE.md) file for details.
54-
55-
## Secrets
56-
** TODO** List here the necessary secrets. DO NOT USE PERSONAL ACCESS TOKENS IN PUBLIC REPOSITORIES.

projects/README.md

Lines changed: 0 additions & 3 deletions
This file was deleted.

resources/README.md

Lines changed: 0 additions & 13 deletions
This file was deleted.

0 commit comments

Comments
 (0)