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
Fix JSON syntax #2
Conversation
@@ -5,15 +5,14 @@ | |||
"keywords": "serial", | |||
"description": "Control thousands of WS2811/2812 LEDs at video refresh speeds", | |||
"url": "http://www.pjrc.com/teensy/td_libs_OctoWS2811.html", | |||
"downloadUrl": "http://www.pjrc.com/teensy/arduino_libraries/OctoWS2811.zip", |
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.
Why did you remove the downloadUrl?
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 removed it, because there is defined "repository" with source code history. Do you need this field?
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've just restored it. Sorry.
I still have mixed feelings about this metadata format, but at least it's a start. My hope is to someday make a library management tool within the Arduino IDE. Actually, I'm really hoping someone else will do this and I can simply use it. Many people have tried to do such tools in the past, but all have abandoned their effort or never really got started (even Arduino has wanted to do this for years, but never made significant progress). For every library I publish, there's a stable download URL, and the work-in-progress GitHub address. It would be nice if both were in the metadata. How some future library manager will actually use those links, I do not know. I'm not very good at predicting the future! Another feature missing is a clear way to specify one or more pages that are the documentation for the library. The description also appears to be limited to only a short description (often an image communicates a visual idea of a library's purpose much easier than reading text). There's also no way to specify well defined categories. In some sort of library manager tool, where many hundreds of libraries are shown to users, all of that type of descriptive metadata will be needed. But at least this format is a good start with basic info. I'd rather start something imperfect and improve as needed, instead of waiting and never making any forward progress due to indecision. |
This is quite easy to do it with PlatformIO Regisrty. The API is open for all. If I had practice with Java + GUI Framework I could help Arduino community with nice GUI tool. As for API:
I agree with you. Thanks.
What do you think about
Are you sure that manifest file should contain more detailed information about library? I think this information should be located in special file/files, documentation or etc., like README file. Then we can define the URL to this README file in
This is good idea. I like Python's package classifiers https://pypi.python.org/pypi?%3Aaction=list_classifiers
I'm totally agree with you. As you can see, I accepted all propositions from you and implemented their, because you were right with "trademarks". I didn't see it early, but Arduino really doesn't allow to use theirs name ... http://arduino.cc/en/Trademark/HomePage?from=Main.Trademark
|
Maybe we should find a better place to discuss these issues, where other people can join in, and where the conversation can be found by anyone interested? On this old github issue, it's only going to be lost. I really do not know the best way to organize metadata. At this point, the idea to make a really great library manager is still only a distant dream. I have not done any real work, so I do not know the issues well at this time. But someday I want to make such a thing... unless someone else does it first. |
👍 |
I've just moved our discussion with a few changes to Arduino Developers group https://groups.google.com/a/arduino.cc/forum/#!topic/developers/xCDjekcQW4k Let's discuss it with others developers 👍 |
For now, I'm going to watch only. The mail list can be very painful and often a huge waste of time. |
No description provided.