kb01/zmk
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

minor improvements

Browse source
This commit is contained in:
Nicolas Munnich 2024-09-03 08:23:19 +02:00
parent cc299e0eae
commit 219cb54d1a
1 changed files with 13 additions and 10 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

23
docs/docs/development/module-creation.md
View file

@ -94,7 +94,7 @@ Make sure to include a `README.md` file and a `LICENSE` file in your repository.
The repository comes with a number of files and folders already positioned for you to edit. The below table describes which files are most likely kept and which are most likely deleted, based on your module's type. Note that these aren't hard rules, merely the most common use case. The only rule that needs to be followed is that unused files and folders should be deleted. The repository comes with a number of files and folders already positioned for you to edit. The below table describes which files are most likely kept and which are most likely deleted, based on your module's type. Note that these aren't hard rules, merely the most common use case. The only rule that needs to be followed is that unused files and folders should be deleted.
| ---------------- | `keyboards` | `components` | `behavior` | `driver` | `feature` | `vfx` | | | `keyboards` | `components` | `behavior` | `driver` | `feature` | `vfx` |
| ---------------- | ----------- | ------------ | ---------- | -------- | --------- | ----- | | ---------------- | ----------- | ------------ | ---------- | -------- | --------- | ----- |
| `board/` | ✅ | ✅ | ❌ | ❌ | ❌ | ✅ | | `board/` | ✅ | ✅ | ❌ | ❌ | ❌ | ✅ |
| `dts/` | ✅ | ❌ | ✅ | ✅ | ✅ | ❌ | | `dts/` | ✅ | ❌ | ✅ | ✅ | ✅ | ❌ |
@ -105,12 +105,15 @@ The repository comes with a number of files and folders already positioned for y
| `snippets/` | ❌ | ❌ | ❌ | ❌ | ✅ | ❌ | | `snippets/` | ❌ | ❌ | ❌ | ❌ | ✅ | ❌ |
The below table reminds of the purpose of each of these files and folders, if you are not already familiar with them: The below table reminds of the purpose of each of these files and folders, if you are not already familiar with them:
| File or Folder | Description |
| ---------------- | -------------------------------------------------------- | | File or Folder | Description |
| `board/` | This folder contains definitions for boards and shields. | | ---------------- | -------------------------------------------------------------------------------------- |
| `dts/` | This folder contains devicetree bindings and includes. | | `board/` | This folder contains definitions for boards and shields. |
| `CMakeLists.txt` | CMake file for the module | | `dts/` | This folder contains devicetree bindings and includes. |
| `Kconfig` | Kconfig file for the module | | `CMakeLists.txt` | CMake file for the module |
| `include/` | Folder to put C header files into | | `Kconfig` | Kconfig file for the module |
| `src/` | Folder for C source files| | `include/` | Folder to put C header files into |
| `snippets/` | Folder for [snippets](https://docs.zephyrproject.org/latest/build/snippets/index.html)| | `src/` | Folder for C source files |
| `snippets/` | Folder for [snippets](https://docs.zephyrproject.org/latest/build/snippets/index.html) |
##