Boards Manager JSON index file format specification:
https://github.com/arduino/Arduino/wiki/Arduino-IDE-1.6.x-package_index.json-format-specification
Arduino IDE 1.6.4 introduced installation of Boards by adding URLs to File > Preferences > Additional Boards Manager URLS:. Boards Manager makes it easy for users to install and keep Boards files up to date. When you create a new version it will automatically be shown as an update option in Boards Manager.
You can see how others have implemented Boards Manager install support at the Unofficial list of 3rd party boards support urls.
Adding Boards Manager install support requires two files to be made available online:
It's worth giving the location of the package index file some thought because it is best not to change the URL after people have already added it to their preferences. You could use a combination of these locations, one for the package index and another for the installation archive:
https://janedeveloper.github.io/myboard/package_janedeveloper_myboard_index.json
).
Note: Using the archive file automatically generated by Github for each commit(e.g., https://github.com/user-name/project/archive/{commit ID}.zip
) as an installation archive file is not a good idea because Github may later modify the file, making the checksum in the package index file incorrect. This will cause a CRC mismatch error during installation in Boards Manager.