Add files library.json and FILE_DESCRIPTIONS.md

This commit is contained in:
Scott Allen 2016-06-30 21:32:20 -04:00
parent d17075f7be
commit d91314cdaf
2 changed files with 40 additions and 0 deletions

View File

@ -0,0 +1,26 @@
# File Descriptions
Documentation for files contained in this repository which aren't self explanatory.
### /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.
See the [Arduino IDE 1.5: Library specification](https://github.com/arduino/Arduino/wiki/Arduino-IDE-1.5:-Library-specification) for details.
### /library.json
This JSON file is a manifest used by the [PlatformIO IDE](http://platformio.org/) to make this library available in its [Library Manager](http://docs.platformio.org/en/latest/librarymanager/index.html).
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.
See the [PlatformIO library.json](http://docs.platformio.org/en/latest/librarymanager/config.html) documentation for details.
### /extras/assets/arduboy_logo.png<br>/extras/assets/arduboy_screen.png
Templates used to create the ARDUBOY logo used in the *bootLogo()* function.
----------

14
library.json Normal file
View File

@ -0,0 +1,14 @@
{
"name": "Arduboy2",
"keywords": "arduboy, game",
"description": "An alternative library for content creation on the Arduboy miniature gaming platform",
"repository":
{
"type": "git",
"url": "https://github.com/MLXXXp/Arduboy2.git"
},
"version": "2.0.0",
"exclude": "extras",
"frameworks": "arduino",
"platforms": "atmelavr"
}