From d91314cdaf42c2c3bb9fa91f56e9c4e193967ced Mon Sep 17 00:00:00 2001 From: Scott Allen Date: Thu, 30 Jun 2016 21:32:20 -0400 Subject: [PATCH] Add files library.json and FILE_DESCRIPTIONS.md --- extras/docs/FILE_DESCRIPTIONS.md | 26 ++++++++++++++++++++++++++ library.json | 14 ++++++++++++++ 2 files changed, 40 insertions(+) create mode 100644 extras/docs/FILE_DESCRIPTIONS.md create mode 100644 library.json diff --git a/extras/docs/FILE_DESCRIPTIONS.md b/extras/docs/FILE_DESCRIPTIONS.md new file mode 100644 index 0000000..7ef06dc --- /dev/null +++ b/extras/docs/FILE_DESCRIPTIONS.md @@ -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
/extras/assets/arduboy_screen.png + +Templates used to create the ARDUBOY logo used in the *bootLogo()* function. + +---------- + diff --git a/library.json b/library.json new file mode 100644 index 0000000..ede30f7 --- /dev/null +++ b/library.json @@ -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" +}