Skip to content

Correct licensing documentation #54

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: master
Choose a base branch
from

Conversation

per1234
Copy link
Contributor

@per1234 per1234 commented May 9, 2025

The project's readme contains a "License" section which summarizes the project licensing.

Previously the information was incorrect (it seems to just be a copy/paste of the content that was present in most of Arduino's libraries at that time, by someone who didn't actually verify that it was appropriate):

  • The copyright assignment for Sebastian Madgwick, the author of the code upon which the library is based was omitted, falsely indicating that Arduino LLC is the sole copyright holder.
  • It stated that the project is licensed as LGPL 2.1, when it is actually the GPL 3.0 licensing inherited from the base code.

The missing copyright assignment is hereby added and the license information corrected.

The text of the license summary is the standard license header for the project's GPL 3.0 license:

https://spdx.org/licenses/GPL-3.0-only.html#licenseHeader

per1234 added 2 commits May 9, 2025 12:18
The library is based on a C implementation of the Madgwick AHRS algorithm provided by Sebastian Madgwick.

Unfortunately the licensing of that base code was not well documented. The licensing was only specified on the website
of Sebastian Madgwick's x-io Technologies website where the code is hosted. Since this important information was
difficult to find, a comment was added to the source code headers which contains a reference link and quote of the
relevant statement.

There were two serious problems with that comment:

* The information was later removed from the linked page.
* The quote did not include the essential link which clarifies exactly which version of the GPL license is offered.

These are resolved by:

* Using a link to an archived version of the reference web page which still provides the licensing information.
* Adding markup to indicate the link in the quoted statement. Since that link relies on a redirect, an archive link is
  also used here in order to avoid future bit rot.
The project's readme contains a "License" section which summarizes the project licensing.

Previously the information was incorrect (it seems to just be a copy/paste of the content that was present in most of
Arduino's libraries at that time, by someone who didn't actually verify that it was appropriate):

* The copyright assignment for Sebastian Madgwick, the author of the code upon which the library is based was omitted,
  falsely indicating that Arduino LLC is the sole copyright holder.
* It stated that the project is licensed as LGPL 2.1, when it is actually the GPL 3.0 licensing inherited from the base
  code.

The missing copyright assignment is hereby added and the license information corrected.
@per1234 per1234 requested a review from sebromero May 9, 2025 19:54
@per1234 per1234 self-assigned this May 9, 2025
@per1234 per1234 added type: imperfection Perceived defect in any part of project topic: documentation Related to documentation for the project labels May 9, 2025
Copy link

github-actions bot commented May 9, 2025

Memory usage change @ bbd3e48

Board flash % RAM for global variables %
Intel:arc32:arduino_101 0 - 0 0.0 - 0.0 N/A N/A
Click for full report table
Board examples/Visualize101
flash
% examples/Visualize101
RAM for global variables
%
Intel:arc32:arduino_101 0 0.0 N/A N/A
Click for full report CSV
Board,examples/Visualize101<br>flash,%,examples/Visualize101<br>RAM for global variables,%
Intel:arc32:arduino_101,0,0.0,N/A,N/A

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
topic: documentation Related to documentation for the project type: imperfection Perceived defect in any part of project
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant