search

bremme / arduino-tm1637

Arduino library for using a 4 digit seven segment display with TM1636 or TM1637 driver IC
GNU General Public License v2.0
164 stars 62 forks source link

Create library.json #35

Closed vazquezjm closed 5 years ago

vazquezjm commented 5 years ago

library.json is a manifest file of development library for PlatformIO. PlatformIO Library Crawler uses library.json manifest to extract source code from developer’s location and keeps a cleaned library in own Library Registry. https://docs.platformio.org/en/latest/librarymanager/config.html#library-json

per1234 commented 5 years ago

What is the purpose of adding a library.json file when this library already has a library.properties file, which is supported by PlatformIO as an alternative to library.json?: https://docs.platformio.org/en/latest/userguide/lib/cmd_register.html#description

Having two metadata files only doubles the maintenance burden and makes it likely that two two will end up out of sync with no benefit that I can see. Since the Arduino IDE does not support library.json, it seems the obvious choice is to just use a single library.properties file.

pfeerick commented 5 years ago

@per1234 Thanks for that... gonna have to do a PR on the docs to fix that... as it clearly states that the library manifest file is the only requirement to register a library... but only mentions the json file... not that others are supported.

The only one requirement is library’s manifest file - library.json.

vazquezjm commented 5 years ago

Hi @bremme! Is there any chance that you could merge this PR? This file will let PlatformIO user add the library from Visual Studio Code among other things. Thanks!

per1234 commented 5 years ago

@vazquezjm did you miss what I said in my previous reply about library.json being unnecessary due to this library already having a library.properties file? Or is there something I don't understand about PlatformIO that makes it still necessary to have a library.json file?