8000 Added library.json for PlatformIO Compatibility by ab-tools · Pull Request #1399 · lz4/lz4 · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

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

Open
wants to merge 2 commits into
base: dev
Choose a base branch
from

Conversation

ab-tools
Copy link
@ab-tools ab-tools commented May 1, 2024

Would you mind adding this library.json file to easily allow using this library within PlatformIO by just referencing your GIT repository?

Thanks
Andreas

@Cyan4973
Copy link
Member
Cyan4973 commented May 8, 2024

Where is this file added ? At the root on the repository ?
In which case, I have 2 questions :

  • Is it possible to add it to a dedicated subdirectory instead ? (exact path to be determined)
  • Does the format of library.json allow comments, thus making it possible to document in the file why it's there and how it works ?

@ab-tools
Copy link
Author
ab-tools commented May 8, 2024

Hello Yann,

first thanks for your reply.

According to the PlatformIO documentation the library.json file has to be in the root directory of the library:
https://docs.platformio.org/en/latest/librarymanager/creating.html#publishing

As it is plain JSON, it cannot contain comments. But you could add a note in the library description JSON element within this file that it is used for PlatformIO.

It would be ideal if the package would be officially published to the PlatformIO registry by the lz4 team here as well:
https://registry.platformio.org

Currently, there is only a very outdated fork available there:
https://registry.platformio.org/libraries/liux-pro/lz4

Thanks for considering
Andreas

library.json Outdated
@@ -0,0 +1,20 @@
{
"name": "lz4",
"version": "1.9.4",
Copy link
Member

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"
Copy link
Member

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

Copy link
Author

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",
Copy link
Member

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

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

URL updated.

@ab-tools
Copy link
Author

Would be great if this could be merged, @Cyan4973!

Thanks
Andreas

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants
0