-
Notifications
You must be signed in to change notification settings - Fork 1.4k
Added library.json for PlatformIO Compatibility #1399
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: dev
Are you sure you want to change the base?
Conversation
Where is this file added ? At the root on the repository ?
|
Hello Yann, first thanks for your reply. According to the PlatformIO documentation the As it is plain JSON, it cannot contain comments. But you could add a note in the library It would be ideal if the package would be officially published to the PlatformIO registry by the lz4 team here as well: Currently, there is only a very outdated fork available there: Thanks for considering |
library.json
Outdated
@@ -0,0 +1,20 @@ | |||
{ | |||
"name": "lz4", | |||
"version": "1.9.4", |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It seems this file implies a manual maintenance of the version
field
library.json
Outdated
"description": "lz4 data compress library, fork from awesome https://github.com/lz4/lz4", | ||
"repository": { | ||
"type": "git", | ||
"url": "https://github.com/liux-pro/lz4" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I presume the url should be updated
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Description corrected.
library.json
Outdated
"name": "lz4", | ||
"version": "1.9.4", | ||
"keywords": "lz4, compress, esp32, esp826, espressif", | ||
"description": "lz4 data compress library, fork from awesome https://github.com/lz4/lz4", |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Well, it's no longer a fork
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
URL updated.
Would be great if this could be merged, @Cyan4973! Thanks |
Would you mind adding this
library.json
file to easily allow using this library within PlatformIO by just referencing your GIT repository?Thanks
Andreas