PlatformIO integration #4015
Open
PlatformIO integration #4015
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
nlohmann
requested changes
Sep 2, 2023
| @@ -0,0 +1,36 @@ | |||
| { | |||
There was a problem hiding this comment.
Is this additional file really needed? I don't want to spam my repository.
There was a problem hiding this comment.
Yes, I confirm. Without the proposed config, PIO tries to build files in all subfolders (including examples) and ends with errors. As a temporary workaround, I had to make a local copy of the headers.
jcracine-cimeq
added a commit
to cimeq/json
that referenced
this pull request
Apr 15, 2024
Note(s): This is based on the pull-request found in the link below. nlohmann#4015 Changes to be committed: modified: README.md new file: library.json
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
First of all thank you for this amazing library. I really do enjoy working with it.
Secondly this pull request is my stab at adding this library to a PlatformIO environment. PlatformIO is a tool that streamlines environment setup for embedded development. It takes care of things like getting proper compiler variant, setting up all the required compiler flags, linker scripts, etc. It even does some IDE setup, if needed. If that weren't enough it also manages libraries and project dependencies reasonably well. This is where this PR comes in.
Each of the PlatformIO libraries needs a
library.jsonfile (which this PR includes) and may be uploaded to PlatformIO's registry (https://registry.platformio.org/) (which this PR does not). Technically uploading to said registry is recommended and makes the libraries slightly easier for users to use, but it requires setting up accounts and regular uploads to said service (which would require a CI changes to be sustainable) so I decided not to include it right now. If the current solution will gain traction among users I can help with setting all the "proper" channels.I also edited
README.md- my changes are in the section Package managers despite PlatformIO technically being closer to a build system due to the said "registry" feature above, which I hope this library make into one day.Sorry for the multiple commits in the PR - I kinda couldn't resist testing the GitHub's online editor for a single JSON ;-) file change.
Let me know what you think and have a wonderful day
Paweł