Releases: berrak/MyMacros
Releases · berrak/MyMacros
cpp-checks, clang-format, and Doxygen documentation.
This release improves in two areas.
- documentation
- code quality
First, Doxygen generates a website from the code itself. Next, GitHub Pages host the final documentation. After that, all code is formatted with 'clang-format' according to LLVM C++ rules. Finally, 'cppcheck' automatically detects flaws, and lastly, all example sketches(s)
are compiled and uploaded to target microcontrollers.
It can be excessive work for such a tiny Library, but if the build system lacks the quality for small tasks, it will not be suitable for the next major project. Thus I see this as an exercise for coming libraries.
Keywords correction
The release is a minor update to the stable 0.5.0 release.
- Correct syntax to enable keyword highlighting in code
- Minor clarification in the README.
Stable release
- Improvements
Add a matching macro for a few different architectures.
For example, the new #define ARCH_IDENTIFY_WARNING will show this at compile time.
The README document had a general clean-up with clarification and some language adjustments.
Addedarduino-lint
to be 100% compliant with the official guidelines.
PR for Arduino Library
Stable version - for the request to be included in the official index of Arduino libraries.
Major rewrite - uprade to this release.
This version is a complete rewrite after extensive testing and is now considered stable and ready for public use.
- New features and improvements
The macros BUILD_BOARD and the 'printlnMatch()' can be used at run-time to quickly find out which board is built in the Arduino IDE.
The README documentation is too large parts updated. It is now more convincing and why you should use this library :-)
The discussion about avoiding duplication of code when working with multiple boards has been extended.
The header file, i.e., the personal macros 'database', has data filled in as examples. But, again, feel free to add or remove as you see fit.
Rewrite the description and remove usage of whitespace in the library name.
- Improvements
- Rewrite the README and simplify the file hierarchy and the usage of symbolic links. Propose a less deep folder structure and use camel case names for Arduino sketches.
- Changed library name, i.e., removed any unambiguous white space, for example, MyMacros instead of 'My Macros.'
- Add the script
mylink
for automation when creating symbolic links.
Functionality update
Corrections
- Update the mylink script to adhere to Arduino IDE's requirement to have the sketches in separate folders when opening code in the device tree hierarchy and not below CODE.
Enhancements
- In addition, the output from
My_Macros.h
includes the matching define, for example,Matched defined(ARDUINO_AVR_UNO)
to remind ourselves what define causes the outcome. These definitions are very useful in the code, and based on that, include, exclude code, or add some macros.
Initial 0.1 Release
This is the first release for wider public use.