fleg
/
Arduboy2
mirror of https://github.com/MLXXXp/Arduboy2.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
Arduboy2/extras/docs/FILE_DESCRIPTIONS.md

27 lines
1.2 KiB
Markdown
Raw Normal View History

Add files library.json and FILE_DESCRIPTIONS.md
2016-07-01 01:32:20 +00:00
# File Descriptions
Refactor API code. Clarify and enhance user docs. Includes some suggestions and guidance by @Pharap API: - Rename non-API function swap() to swapInt16() - Make swapInt16(), drawCircleHelper(), fillCircleHelper() and struct BitStreamReader protected members of Arduboy2Base - Add #define ARDUBOY_UNIT_NAME_BUFFER_SIZE for the size of a buffer to hold a Unit Name - Move the position of the PROGMEM keyword for lcdBootProgram[] for consistency Documentation: - Remove absolute values referring to a Unit Name - More details relating to the use of the Unit Name - More details relating to the font and text functions - Other minor documentation changes and spelling corrections
2020-06-18 21:37:33 +00:00
Documentation for files contained in this repository that aren't self explanatory.
Add files library.json and FILE_DESCRIPTIONS.md
2016-07-01 01:32:20 +00:00
### /library.properties
Provides information so that this library can be installed and updated in the Arduino IDE using the [Library Manager](https://www.arduino.cc/en/Guide/Libraries#toc3).
The value of *version* must be set to the latest stable tagged release. This should be changed and commited just before tagging the new release.
Update or remove outdated URLs
2020-06-30 23:06:58 +00:00
See the [Arduino IDE 1.5: Library specification](https://arduino.github.io/arduino-cli/library-specification/) for details.
Add files library.json and FILE_DESCRIPTIONS.md
2016-07-01 01:32:20 +00:00
### /library.json
Update or remove outdated URLs
2020-06-30 23:06:58 +00:00
This JSON file is a manifest used by the [PlatformIO IDE](https://platformio.org/) to make this library available in its [Library Manager](https://docs.platformio.org/en/latest/librarymanager/index.html).
Add files library.json and FILE_DESCRIPTIONS.md
2016-07-01 01:32:20 +00:00
The value of *version* must be set to the latest stable tagged release. This should be changed and commited just before tagging the new release.
Update or remove outdated URLs
2020-06-30 23:06:58 +00:00
See the [PlatformIO library.json](https://docs.platformio.org/en/latest/librarymanager/config.html) documentation for details.
Add files library.json and FILE_DESCRIPTIONS.md
2016-07-01 01:32:20 +00:00
### /extras/assets/arduboy_logo.png<br>/extras/assets/arduboy_screen.png
Templates used to create the ARDUBOY logo used in the *bootLogo()* function.
----------