Library Contribution Help

Software IDE 2.x
1

I have my own library that could be useful to others. I would like to publish it & make it available to the Arduino community, but need a bit of help to achieve that. I do understand I need to structure according to community standards. I believe I will need to push that onto the GitHub repository, and I believe I will need to submit some sort of application to an administrator to approve its inclusion & make it searchable by a user of the Library Manager.

I'm sure this path has been trodden by many before me. I couldn't figure out what's the right category for this. I guess there's already a written guide to do this. Could someone point me in the right direction, please?

2

There are lots of ways to share libraries. Including posting them in a zip file.
Or uploading to github...

The official guide for how to do it if you wish to add your library to the library manager can be found
at:
Library specification - Arduino CLI

1 Like
3

Putting it on GitHub and getting it listed in the IDE are two separate steps.

There are lots of libraries on GitHub that are not listed in the IDE. This isn't a big problem as long as people can find the library through a Google search. As a bare minimum you need to describe what it does, what Arduino models are supported and include a demo sketch.

If so far you are the only person to look at the code then perhaps the first step is to put it on GitHub and ask for other people to look for bugs and make comments. Once you are confident that it's in a fit state for the masses then by all means go through the steps to get it listed in the IDE.

2 Likes
4

Thanks guys. Thanks @KurtE. Thanks @mikb55. I have had a look at the links you have sent. I believe that’s just what I need. :pray:

5

Once you are ready to add the library to the Arduino Library Manager, you can find the instructions here:

https://github.com/arduino/library-registry#adding-a-library-to-library-manager

If you have any problems or questions while doing that, let us know and we'll provide assistance.

2 Likes
6

I thought I had followed process to add my library to library manager, but got snag because I hadn't set Release / Tag to match my library.properties file. I'm now a bit lost in trying to finish the job. My library.properties says 0.0.1 whereas GitHub release says v0.0.1 - both seem to follow recommendations. I'm just struggling to get over the finishing line. Can you help @ptillisch ?

My account on GitHub is rtdgreg. The library is TWI_GPS.

7

Hi @rtdgreg. Thanks for your interest in contributing to the Arduino Library Manager.

I provided some guidance in how to resolve the problem over on GitHub:

https://github.com/arduino/library-registry/pull/3408#pullrequestreview-1651828591

Please give that a try.

Let me know if you have any questions or problems.

8

Thanks @ptillisch. Library now successfully published. I have marked as resolved.

9

You are welcome. I'm glad your submission was successful.

Regards,
Per

1 Like
10

This topic was automatically closed 180 days after the last reply. New replies are no longer allowed.