Go Down

Topic: New libraries in the GitHub (Read 728 times) previous topic - next topic

Hi,

Sorry if this one do not is the forum ideal for question, but someone know to inform how i post a libreries in the Github for the commmunity Arduino.

Libraries created per me.

Thankyou.
Esp. Sandro Mesquita
Industrial Mecatronic in Institute Federal of Ceará
Specialist in Engineer of Petroleum
Specialist in Industrial Automotation

pert

Hello. I want to be sure I understand the question. Are you asking how to publish a library on GitHub?

Hello. I want to be sure I understand the question. Are you asking how to publish a library on GitHub?
Yes, but the goal is to publish for validation in the Arduino directory.
It is possible?
Esp. Sandro Mesquita
Industrial Mecatronic in Institute Federal of Ceará
Specialist in Engineer of Petroleum
Specialist in Industrial Automotation

pert

By "validation in the Arduino directory", I'm guessing you mean that you want to add your library to the Arduino Library Manager index. If I guessed wrong, please correct me.

There are a few requirement for this:

The library must be in the root of the repository, not under a subfolder. Let's say your repository was named Foo. This would be the structure if your library is in the 1.5 format:

Foo
|_library.properties
|_examples
|_src

This would be the structure if your library is in the 1.0 format:

Foo
|_Foo.cpp
|_Foo.h
|_library.properties
|_examples

You can use the official Arduino library repositories as a model:
https://github.com/arduino-libraries



The library must have a library.properties file. This is required even if the library is in the 1.0 format. The library.properties file must be compliant with the specification:
https://github.com/arduino/Arduino/wiki/Arduino-IDE-1.5:-Library-specification#libraryproperties-file-format


The repository must have a Git tag or GitHub release.


There are a few other requirements which are explained here:
https://github.com/arduino/Arduino/wiki/Library-Manager-FAQ


Once you have your library published on GitHub in the correct form, you only need to open an issue in the arduino/Arduino repository requesting addition to the Arduino Library Manager index, with the URL of the repository.


Please let me know if you have any questions or would like me to take a look at one of your repositories.

By "validation in the Arduino directory", I'm guessing you mean that you want to add your library to the Arduino Library Manager index. If I guessed wrong, please correct me.

There are a few requirement for this:

The library must be in the root of the repository, not under a subfolder. Let's say your repository was named Foo. This would be the structure if your library is in the 1.5 format:

Foo
|_library.properties
|_examples
|_src

This would be the structure if your library is in the 1.0 format:

Foo
|_Foo.cpp
|_Foo.h
|_library.properties
|_examples

You can use the official Arduino library repositories as a model:
https://github.com/arduino-libraries



The library must have a library.properties file. This is required even if the library is in the 1.0 format. The library.properties file must be compliant with the specification:
https://github.com/arduino/Arduino/wiki/Arduino-IDE-1.5:-Library-specification#libraryproperties-file-format


The repository must have a Git tag or GitHub release.


There are a few other requirements which are explained here:
https://github.com/arduino/Arduino/wiki/Library-Manager-FAQ


Once you have your library published on GitHub in the correct form, you only need to open an issue in the arduino/Arduino repository requesting addition to the Arduino Library Manager index, with the URL of the repository.


Please let me know if you have any questions or would like me to take a look at one of your repositories.
Thanks, I'll take the look at the links.
Esp. Sandro Mesquita
Industrial Mecatronic in Institute Federal of Ceará
Specialist in Engineer of Petroleum
Specialist in Industrial Automotation

Friend Pert, thakyou for you help, i saw your help, but is very hard, only published no gitHub for download same.

Other day i study more for learn.

https://github.com/Sandromesquita/libraries
Esp. Sandro Mesquita
Industrial Mecatronic in Institute Federal of Ceará
Specialist in Engineer of Petroleum
Specialist in Industrial Automotation

pert

No, no, no!

First problem: the library name "libraries" indicates you plan to stuff a bunch of libraries in the same repository. Don't do that! Use a separate repository for each library. This is required for inclusion in the Arduino Library Manager. Even if you don't care about Library Manager, putting multiple libraries in the same repository is a huge mistake. It is harmful to the version control features of Git. It is harmful to the collaborative features of GitHub. It makes library installation much more difficult. GitHub gives you unlimited free repositories, so there's no reason to be stingy with using them.

Second problem: don't ever put compressed files in the repository. This defeats all the wonderful version control and collaborative features of Git and GitHub. GitHub automatically generates .zip files of the repository via the "Clone or Download > Download ZIP" button on the home page and dedicated links for each release on the Releases page.

My friend, very thank for help, you are very helpfull and attentive.

thankyou of heart, i will go change now.
Esp. Sandro Mesquita
Industrial Mecatronic in Institute Federal of Ceará
Specialist in Engineer of Petroleum
Specialist in Industrial Automotation

Ready, changed.

How do i delete the compressed file?
Esp. Sandro Mesquita
Industrial Mecatronic in Institute Federal of Ceará
Specialist in Engineer of Petroleum
Specialist in Industrial Automotation

pert

How do i delete the compressed file?
If you want to do it via the GitHub web interface:
  • Click on the file you want to delete.
  • Click the trash can icon on the right side of the screen.
  • Click the "Commit changes" button.



If you want to do it via the GitHub web interface:
  • Click on the file you want to delete.
  • Click the trash can icon on the right side of the screen.
  • Click the "Commit changes" button.



It worked, thank you very much for your help.

https://github.com/Sandromesquita/librarie-BridgeHL293/tree/master
Esp. Sandro Mesquita
Industrial Mecatronic in Institute Federal of Ceará
Specialist in Engineer of Petroleum
Specialist in Industrial Automotation

pert

There are a few other problems with the repository. I was planning to submit pull requests to fix them, since that seems like an easy way to communicate the changes that need to be made. However, you still haven't merged the pull request I submitted two days ago:
https://github.com/Sandromesquita/librarie-BridgeHL293/pull/1


I recommend that you click the "Watch" button on the home page of your repository and then set it to "Watching". This will make it so you get notifications when people submit pull requests or bug reports to your repositories. Unfortunately, GitHub recently changed so that the default setting of repositories is "Not Watching", so you need to remember to do that manually each time you create a repository.

There are a few other problems with the repository. I was planning to submit pull requests to fix them, since that seems like an easy way to communicate the changes that need to be made. However, you still haven't merged the pull request I submitted two days ago:
https://github.com/Sandromesquita/librarie-BridgeHL293/pull/1


I recommend that you click the "Watch" button on the home page of your repository and then set it to "Watching". This will make it so you get notifications when people submit pull requests or bug reports to your repositories. Unfortunately, GitHub recently changed so that the default setting of repositories is "Not Watching", so you need to remember to do that manually each time you create a repository.
Ready, changed.
Esp. Sandro Mesquita
Industrial Mecatronic in Institute Federal of Ceará
Specialist in Engineer of Petroleum
Specialist in Industrial Automotation

pert

Ready, changed.
No, it's not. Please take the time to learn how to merge pull requests:
https://help.github.com/articles/merging-a-pull-request/
It's as easy as clicking a couple of buttons. This is an essential skill to learn for anyone with a public repository on GitHub.

No, it's not. Please take the time to learn how to merge pull requests:
https://help.github.com/articles/merging-a-pull-request/
It's as easy as clicking a couple of buttons. This is an essential skill to learn for anyone with a public repository on GitHub.
Sorry, i am go read now.
Esp. Sandro Mesquita
Industrial Mecatronic in Institute Federal of Ceará
Specialist in Engineer of Petroleum
Specialist in Industrial Automotation

Go Up