Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What
This pull request adds a folder structure to the Software folder.
Previously all files were added to the Software folder, without a folder hierarchy.
How
It does this by adding a
src
folder to the Software folder, and adding a folder structure within thesrc
folder.The reason for adding a
src
folder is found on the Arduino forum.TL;DR: it is not possible to create a folder structure in an Arduino sketch without a
src
folder.The following structure is implemented:
The folders added for the libraries correspond to the name of the GitHub hosts and name of the GitHub repository where the files were taken from.
Why
The changes done in this pull request intend to do the following:
Software.ino
andUSER_SETTINGS.h
. This is achieved by only leaving these files outside thesrc
folder.BYD-CAN.h
used to describe a battery or an inverter?" Now it is immediately clear from the folder structure thatBYD-CAN.h
is included as an inverter file.#include
. Adding a folder structure and updating the#include
statements accordingly, indirectly documents what kind of file (e.g. a file from a library, or a file specific to this development board) is included.Note
In case any changes are needed to the folder structure proposed, please let me know, then I will update this pull request accordingly.