Update license to BY-SA-4.0, and update Readme

This commit is contained in:
Nicholas Parks Young 2023-05-20 23:01:33 +01:00
parent f4b3a174fd
commit 7ee35c27e3
3 changed files with 521 additions and 532 deletions

View File

@ -1,504 +1,427 @@
GNU LESSER GENERAL PUBLIC LICENSE Attribution-ShareAlike 4.0 International
Version 2.1, February 1999
=======================================================================
Copyright (C) 1991, 1999 Free Software Foundation, Inc.
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA Creative Commons Corporation ("Creative Commons") is not a law firm and
Everyone is permitted to copy and distribute verbatim copies does not provide legal services or legal advice. Distribution of
of this license document, but changing it is not allowed. Creative Commons public licenses does not create a lawyer-client or
other relationship. Creative Commons makes its licenses and related
[This is the first released version of the Lesser GPL. It also counts information available on an "as-is" basis. Creative Commons gives no
as the successor of the GNU Library Public License, version 2, hence warranties regarding its licenses, any material licensed under their
the version number 2.1.] terms and conditions, or any related information. Creative Commons
disclaims all liability for damages resulting from their use to the
Preamble fullest extent possible.
The licenses for most software are designed to take away your Using Creative Commons Public Licenses
freedom to share and change it. By contrast, the GNU General Public
Licenses are intended to guarantee your freedom to share and change Creative Commons public licenses provide a standard set of terms and
free software--to make sure the software is free for all its users. conditions that creators and other rights holders may use to share
original works of authorship and other material subject to copyright
This license, the Lesser General Public License, applies to some and certain other rights specified in the public license below. The
specially designated software packages--typically libraries--of the following considerations are for informational purposes only, are not
Free Software Foundation and other authors who decide to use it. You exhaustive, and do not form part of our licenses.
can use it too, but we suggest you first think carefully about whether
this license or the ordinary General Public License is the better Considerations for licensors: Our public licenses are
strategy to use in any particular case, based on the explanations below. intended for use by those authorized to give the public
permission to use material in ways otherwise restricted by
When we speak of free software, we are referring to freedom of use, copyright and certain other rights. Our licenses are
not price. Our General Public Licenses are designed to make sure that irrevocable. Licensors should read and understand the terms
you have the freedom to distribute copies of free software (and charge and conditions of the license they choose before applying it.
for this service if you wish); that you receive source code or can get Licensors should also secure all rights necessary before
it if you want it; that you can change the software and use pieces of applying our licenses so that the public can reuse the
it in new free programs; and that you are informed that you can do material as expected. Licensors should clearly mark any
these things. material not subject to the license. This includes other CC-
licensed material, or material used under an exception or
To protect your rights, we need to make restrictions that forbid limitation to copyright. More considerations for licensors:
distributors to deny you these rights or to ask you to surrender these wiki.creativecommons.org/Considerations_for_licensors
rights. These restrictions translate to certain responsibilities for
you if you distribute copies of the library or if you modify it. Considerations for the public: By using one of our public
licenses, a licensor grants the public permission to use the
For example, if you distribute copies of the library, whether gratis licensed material under specified terms and conditions. If
or for a fee, you must give the recipients all the rights that we gave the licensor's permission is not necessary for any reason--for
you. You must make sure that they, too, receive or can get the source example, because of any applicable exception or limitation to
code. If you link other code with the library, you must provide copyright--then that use is not regulated by the license. Our
complete object files to the recipients, so that they can relink them licenses grant only permissions under copyright and certain
with the library after making changes to the library and recompiling other rights that a licensor has authority to grant. Use of
it. And you must show them these terms so they know their rights. the licensed material may still be restricted for other
reasons, including because others have copyright or other
We protect your rights with a two-step method: (1) we copyright the rights in the material. A licensor may make special requests,
library, and (2) we offer you this license, which gives you legal such as asking that all changes be marked or described.
permission to copy, distribute and/or modify the library. Although not required by our licenses, you are encouraged to
respect those requests where reasonable. More_considerations
To protect each distributor, we want to make it very clear that for the public:
there is no warranty for the free library. Also, if the library is wiki.creativecommons.org/Considerations_for_licensees
modified by someone else and passed on, the recipients should know
that what they have is not the original version, so that the original =======================================================================
author's reputation will not be affected by problems that might be
introduced by others. Creative Commons Attribution-ShareAlike 4.0 International Public
License
Finally, software patents pose a constant threat to the existence of
any free program. We wish to make sure that a company cannot By exercising the Licensed Rights (defined below), You accept and agree
effectively restrict the users of a free program by obtaining a to be bound by the terms and conditions of this Creative Commons
restrictive license from a patent holder. Therefore, we insist that Attribution-ShareAlike 4.0 International Public License ("Public
any patent license obtained for a version of the library must be License"). To the extent this Public License may be interpreted as a
consistent with the full freedom of use specified in this license. contract, You are granted the Licensed Rights in consideration of Your
acceptance of these terms and conditions, and the Licensor grants You
Most GNU software, including some libraries, is covered by the such rights in consideration of benefits the Licensor receives from
ordinary GNU General Public License. This license, the GNU Lesser making the Licensed Material available under these terms and
General Public License, applies to certain designated libraries, and conditions.
is quite different from the ordinary General Public License. We use
this license for certain libraries in order to permit linking those
libraries into non-free programs. Section 1 -- Definitions.
When a program is linked with a library, whether statically or using a. Adapted Material means material subject to Copyright and Similar
a shared library, the combination of the two is legally speaking a Rights that is derived from or based upon the Licensed Material
combined work, a derivative of the original library. The ordinary and in which the Licensed Material is translated, altered,
General Public License therefore permits such linking only if the arranged, transformed, or otherwise modified in a manner requiring
entire combination fits its criteria of freedom. The Lesser General permission under the Copyright and Similar Rights held by the
Public License permits more lax criteria for linking other code with Licensor. For purposes of this Public License, where the Licensed
the library. Material is a musical work, performance, or sound recording,
Adapted Material is always produced where the Licensed Material is
We call this license the "Lesser" General Public License because it synched in timed relation with a moving image.
does Less to protect the user's freedom than the ordinary General
Public License. It also provides other free software developers Less b. Adapter's License means the license You apply to Your Copyright
of an advantage over competing non-free programs. These disadvantages and Similar Rights in Your contributions to Adapted Material in
are the reason we use the ordinary General Public License for many accordance with the terms and conditions of this Public License.
libraries. However, the Lesser license provides advantages in certain
special circumstances. c. BY-SA Compatible License means a license listed at
creativecommons.org/compatiblelicenses, approved by Creative
For example, on rare occasions, there may be a special need to Commons as essentially the equivalent of this Public License.
encourage the widest possible use of a certain library, so that it becomes
a de-facto standard. To achieve this, non-free programs must be d. Copyright and Similar Rights means copyright and/or similar rights
allowed to use the library. A more frequent case is that a free closely related to copyright including, without limitation,
library does the same job as widely used non-free libraries. In this performance, broadcast, sound recording, and Sui Generis Database
case, there is little to gain by limiting the free library to free Rights, without regard to how the rights are labeled or
software only, so we use the Lesser General Public License. categorized. For purposes of this Public License, the rights
specified in Section 2(b)(1)-(2) are not Copyright and Similar
In other cases, permission to use a particular library in non-free Rights.
programs enables a greater number of people to use a large body of
free software. For example, permission to use the GNU C Library in e. Effective Technological Measures means those measures that, in the
non-free programs enables many more people to use the whole GNU absence of proper authority, may not be circumvented under laws
operating system, as well as its variant, the GNU/Linux operating fulfilling obligations under Article 11 of the WIPO Copyright
system. Treaty adopted on December 20, 1996, and/or similar international
agreements.
Although the Lesser General Public License is Less protective of the
users' freedom, it does ensure that the user of a program that is f. Exceptions and Limitations means fair use, fair dealing, and/or
linked with the Library has the freedom and the wherewithal to run any other exception or limitation to Copyright and Similar Rights
that program using a modified version of the Library. that applies to Your use of the Licensed Material.
The precise terms and conditions for copying, distribution and g. License Elements means the license attributes listed in the name
modification follow. Pay close attention to the difference between a of a Creative Commons Public License. The License Elements of this
"work based on the library" and a "work that uses the library". The Public License are Attribution and ShareAlike.
former contains code derived from the library, whereas the latter must
be combined with the library in order to run. h. Licensed Material means the artistic or literary work, database,
or other material to which the Licensor applied this Public
GNU LESSER GENERAL PUBLIC LICENSE License.
TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
i. Licensed Rights means the rights granted to You subject to the
0. This License Agreement applies to any software library or other terms and conditions of this Public License, which are limited to
program which contains a notice placed by the copyright holder or all Copyright and Similar Rights that apply to Your use of the
other authorized party saying it may be distributed under the terms of Licensed Material and that the Licensor has authority to license.
this Lesser General Public License (also called "this License").
Each licensee is addressed as "you". j. Licensor means the individual(s) or entity(ies) granting rights
under this Public License.
A "library" means a collection of software functions and/or data
prepared so as to be conveniently linked with application programs k. Share means to provide material to the public by any means or
(which use some of those functions and data) to form executables. process that requires permission under the Licensed Rights, such
as reproduction, public display, public performance, distribution,
The "Library", below, refers to any such software library or work dissemination, communication, or importation, and to make material
which has been distributed under these terms. A "work based on the available to the public including in ways that members of the
Library" means either the Library or any derivative work under public may access the material from a place and at a time
copyright law: that is to say, a work containing the Library or a individually chosen by them.
portion of it, either verbatim or with modifications and/or translated
straightforwardly into another language. (Hereinafter, translation is l. Sui Generis Database Rights means rights other than copyright
included without limitation in the term "modification".) resulting from Directive 96/9/EC of the European Parliament and of
the Council of 11 March 1996 on the legal protection of databases,
"Source code" for a work means the preferred form of the work for as amended and/or succeeded, as well as other essentially
making modifications to it. For a library, complete source code means equivalent rights anywhere in the world.
all the source code for all modules it contains, plus any associated
interface definition files, plus the scripts used to control compilation m. You means the individual or entity exercising the Licensed Rights
and installation of the library. under this Public License. Your has a corresponding meaning.
Activities other than copying, distribution and modification are not
covered by this License; they are outside its scope. The act of Section 2 -- Scope.
running a program using the Library is not restricted, and output from
such a program is covered only if its contents constitute a work based a. License grant.
on the Library (independent of the use of the Library in a tool for
writing it). Whether that is true depends on what the Library does 1. Subject to the terms and conditions of this Public License,
and what the program that uses the Library does. the Licensor hereby grants You a worldwide, royalty-free,
non-sublicensable, non-exclusive, irrevocable license to
1. You may copy and distribute verbatim copies of the Library's exercise the Licensed Rights in the Licensed Material to:
complete source code as you receive it, in any medium, provided that
you conspicuously and appropriately publish on each copy an a. reproduce and Share the Licensed Material, in whole or
appropriate copyright notice and disclaimer of warranty; keep intact in part; and
all the notices that refer to this License and to the absence of any
warranty; and distribute a copy of this License along with the b. produce, reproduce, and Share Adapted Material.
Library.
2. Exceptions and Limitations. For the avoidance of doubt, where
You may charge a fee for the physical act of transferring a copy, Exceptions and Limitations apply to Your use, this Public
and you may at your option offer warranty protection in exchange for a License does not apply, and You do not need to comply with
fee. its terms and conditions.
2. You may modify your copy or copies of the Library or any portion 3. Term. The term of this Public License is specified in Section
of it, thus forming a work based on the Library, and copy and 6(a).
distribute such modifications or work under the terms of Section 1
above, provided that you also meet all of these conditions: 4. Media and formats; technical modifications allowed. The
Licensor authorizes You to exercise the Licensed Rights in
a) The modified work must itself be a software library. all media and formats whether now known or hereafter created,
and to make technical modifications necessary to do so. The
b) You must cause the files modified to carry prominent notices Licensor waives and/or agrees not to assert any right or
stating that you changed the files and the date of any change. authority to forbid You from making technical modifications
necessary to exercise the Licensed Rights, including
c) You must cause the whole of the work to be licensed at no technical modifications necessary to circumvent Effective
charge to all third parties under the terms of this License. Technological Measures. For purposes of this Public License,
simply making modifications authorized by this Section 2(a)
d) If a facility in the modified Library refers to a function or a (4) never produces Adapted Material.
table of data to be supplied by an application program that uses
the facility, other than as an argument passed when the facility 5. Downstream recipients.
is invoked, then you must make a good faith effort to ensure that,
in the event an application does not supply such function or a. Offer from the Licensor -- Licensed Material. Every
table, the facility still operates, and performs whatever part of recipient of the Licensed Material automatically
its purpose remains meaningful. receives an offer from the Licensor to exercise the
Licensed Rights under the terms and conditions of this
(For example, a function in a library to compute square roots has Public License.
a purpose that is entirely well-defined independent of the
application. Therefore, Subsection 2d requires that any b. Additional offer from the Licensor -- Adapted Material.
application-supplied function or table used by this function must Every recipient of Adapted Material from You
be optional: if the application does not supply it, the square automatically receives an offer from the Licensor to
root function must still compute square roots.) exercise the Licensed Rights in the Adapted Material
under the conditions of the Adapter's License You apply.
These requirements apply to the modified work as a whole. If
identifiable sections of that work are not derived from the Library, c. No downstream restrictions. You may not offer or impose
and can be reasonably considered independent and separate works in any additional or different terms or conditions on, or
themselves, then this License, and its terms, do not apply to those apply any Effective Technological Measures to, the
sections when you distribute them as separate works. But when you Licensed Material if doing so restricts exercise of the
distribute the same sections as part of a whole which is a work based Licensed Rights by any recipient of the Licensed
on the Library, the distribution of the whole must be on the terms of Material.
this License, whose permissions for other licensees extend to the
entire whole, and thus to each and every part regardless of who wrote 6. No endorsement. Nothing in this Public License constitutes or
it. may be construed as permission to assert or imply that You
are, or that Your use of the Licensed Material is, connected
Thus, it is not the intent of this section to claim rights or contest with, or sponsored, endorsed, or granted official status by,
your rights to work written entirely by you; rather, the intent is to the Licensor or others designated to receive attribution as
exercise the right to control the distribution of derivative or provided in Section 3(a)(1)(A)(i).
collective works based on the Library.
b. Other rights.
In addition, mere aggregation of another work not based on the Library
with the Library (or with a work based on the Library) on a volume of 1. Moral rights, such as the right of integrity, are not
a storage or distribution medium does not bring the other work under licensed under this Public License, nor are publicity,
the scope of this License. privacy, and/or other similar personality rights; however, to
the extent possible, the Licensor waives and/or agrees not to
3. You may opt to apply the terms of the ordinary GNU General Public assert any such rights held by the Licensor to the limited
License instead of this License to a given copy of the Library. To do extent necessary to allow You to exercise the Licensed
this, you must alter all the notices that refer to this License, so Rights, but not otherwise.
that they refer to the ordinary GNU General Public License, version 2,
instead of to this License. (If a newer version than version 2 of the 2. Patent and trademark rights are not licensed under this
ordinary GNU General Public License has appeared, then you can specify Public License.
that version instead if you wish.) Do not make any other change in
these notices. 3. To the extent possible, the Licensor waives any right to
collect royalties from You for the exercise of the Licensed
Once this change is made in a given copy, it is irreversible for Rights, whether directly or through a collecting society
that copy, so the ordinary GNU General Public License applies to all under any voluntary or waivable statutory or compulsory
subsequent copies and derivative works made from that copy. licensing scheme. In all other cases the Licensor expressly
reserves any right to collect such royalties.
This option is useful when you wish to copy part of the code of
the Library into a program that is not a library.
Section 3 -- License Conditions.
4. You may copy and distribute the Library (or a portion or
derivative of it, under Section 2) in object code or executable form Your exercise of the Licensed Rights is expressly made subject to the
under the terms of Sections 1 and 2 above provided that you accompany following conditions.
it with the complete corresponding machine-readable source code, which
must be distributed under the terms of Sections 1 and 2 above on a a. Attribution.
medium customarily used for software interchange.
1. If You Share the Licensed Material (including in modified
If distribution of object code is made by offering access to copy form), You must:
from a designated place, then offering equivalent access to copy the
source code from the same place satisfies the requirement to a. retain the following if it is supplied by the Licensor
distribute the source code, even though third parties are not with the Licensed Material:
compelled to copy the source along with the object code.
i. identification of the creator(s) of the Licensed
5. A program that contains no derivative of any portion of the Material and any others designated to receive
Library, but is designed to work with the Library by being compiled or attribution, in any reasonable manner requested by
linked with it, is called a "work that uses the Library". Such a the Licensor (including by pseudonym if
work, in isolation, is not a derivative work of the Library, and designated);
therefore falls outside the scope of this License.
ii. a copyright notice;
However, linking a "work that uses the Library" with the Library
creates an executable that is a derivative of the Library (because it iii. a notice that refers to this Public License;
contains portions of the Library), rather than a "work that uses the
library". The executable is therefore covered by this License. iv. a notice that refers to the disclaimer of
Section 6 states terms for distribution of such executables. warranties;
When a "work that uses the Library" uses material from a header file v. a URI or hyperlink to the Licensed Material to the
that is part of the Library, the object code for the work may be a extent reasonably practicable;
derivative work of the Library even though the source code is not.
Whether this is true is especially significant if the work can be b. indicate if You modified the Licensed Material and
linked without the Library, or if the work is itself a library. The retain an indication of any previous modifications; and
threshold for this to be true is not precisely defined by law.
c. indicate the Licensed Material is licensed under this
If such an object file uses only numerical parameters, data Public License, and include the text of, or the URI or
structure layouts and accessors, and small macros and small inline hyperlink to, this Public License.
functions (ten lines or less in length), then the use of the object
file is unrestricted, regardless of whether it is legally a derivative 2. You may satisfy the conditions in Section 3(a)(1) in any
work. (Executables containing this object code plus portions of the reasonable manner based on the medium, means, and context in
Library will still fall under Section 6.) which You Share the Licensed Material. For example, it may be
reasonable to satisfy the conditions by providing a URI or
Otherwise, if the work is a derivative of the Library, you may hyperlink to a resource that includes the required
distribute the object code for the work under the terms of Section 6. information.
Any executables containing that work also fall under Section 6,
whether or not they are linked directly with the Library itself. 3. If requested by the Licensor, You must remove any of the
information required by Section 3(a)(1)(A) to the extent
6. As an exception to the Sections above, you may also combine or reasonably practicable.
link a "work that uses the Library" with the Library to produce a
work containing portions of the Library, and distribute that work b. ShareAlike.
under terms of your choice, provided that the terms permit
modification of the work for the customer's own use and reverse In addition to the conditions in Section 3(a), if You Share
engineering for debugging such modifications. Adapted Material You produce, the following conditions also apply.
You must give prominent notice with each copy of the work that the 1. The Adapter's License You apply must be a Creative Commons
Library is used in it and that the Library and its use are covered by license with the same License Elements, this version or
this License. You must supply a copy of this License. If the work later, or a BY-SA Compatible License.
during execution displays copyright notices, you must include the
copyright notice for the Library among them, as well as a reference 2. You must include the text of, or the URI or hyperlink to, the
directing the user to the copy of this License. Also, you must do one Adapter's License You apply. You may satisfy this condition
of these things: in any reasonable manner based on the medium, means, and
context in which You Share Adapted Material.
a) Accompany the work with the complete corresponding
machine-readable source code for the Library including whatever 3. You may not offer or impose any additional or different terms
changes were used in the work (which must be distributed under or conditions on, or apply any Effective Technological
Sections 1 and 2 above); and, if the work is an executable linked Measures to, Adapted Material that restrict exercise of the
with the Library, with the complete machine-readable "work that rights granted under the Adapter's License You apply.
uses the Library", as object code and/or source code, so that the
user can modify the Library and then relink to produce a modified
executable containing the modified Library. (It is understood Section 4 -- Sui Generis Database Rights.
that the user who changes the contents of definitions files in the
Library will not necessarily be able to recompile the application Where the Licensed Rights include Sui Generis Database Rights that
to use the modified definitions.) apply to Your use of the Licensed Material:
b) Use a suitable shared library mechanism for linking with the a. for the avoidance of doubt, Section 2(a)(1) grants You the right
Library. A suitable mechanism is one that (1) uses at run time a to extract, reuse, reproduce, and Share all or a substantial
copy of the library already present on the user's computer system, portion of the contents of the database;
rather than copying library functions into the executable, and (2)
will operate properly with a modified version of the library, if b. if You include all or a substantial portion of the database
the user installs one, as long as the modified version is contents in a database in which You have Sui Generis Database
interface-compatible with the version that the work was made with. Rights, then the database in which You have Sui Generis Database
Rights (but not its individual contents) is Adapted Material,
c) Accompany the work with a written offer, valid for at
least three years, to give the same user the materials including for purposes of Section 3(b); and
specified in Subsection 6a, above, for a charge no more c. You must comply with the conditions in Section 3(a) if You Share
than the cost of performing this distribution. all or a substantial portion of the contents of the database.
d) If distribution of the work is made by offering access to copy For the avoidance of doubt, this Section 4 supplements and does not
from a designated place, offer equivalent access to copy the above replace Your obligations under this Public License where the Licensed
specified materials from the same place. Rights include other Copyright and Similar Rights.
e) Verify that the user has already received a copy of these
materials or that you have already sent this user a copy. Section 5 -- Disclaimer of Warranties and Limitation of Liability.
For an executable, the required form of the "work that uses the a. UNLESS OTHERWISE SEPARATELY UNDERTAKEN BY THE LICENSOR, TO THE
Library" must include any data and utility programs needed for EXTENT POSSIBLE, THE LICENSOR OFFERS THE LICENSED MATERIAL AS-IS
reproducing the executable from it. However, as a special exception, AND AS-AVAILABLE, AND MAKES NO REPRESENTATIONS OR WARRANTIES OF
the materials to be distributed need not include anything that is ANY KIND CONCERNING THE LICENSED MATERIAL, WHETHER EXPRESS,
normally distributed (in either source or binary form) with the major IMPLIED, STATUTORY, OR OTHER. THIS INCLUDES, WITHOUT LIMITATION,
components (compiler, kernel, and so on) of the operating system on WARRANTIES OF TITLE, MERCHANTABILITY, FITNESS FOR A PARTICULAR
which the executable runs, unless that component itself accompanies PURPOSE, NON-INFRINGEMENT, ABSENCE OF LATENT OR OTHER DEFECTS,
the executable. ACCURACY, OR THE PRESENCE OR ABSENCE OF ERRORS, WHETHER OR NOT
KNOWN OR DISCOVERABLE. WHERE DISCLAIMERS OF WARRANTIES ARE NOT
It may happen that this requirement contradicts the license ALLOWED IN FULL OR IN PART, THIS DISCLAIMER MAY NOT APPLY TO YOU.
restrictions of other proprietary libraries that do not normally
accompany the operating system. Such a contradiction means you cannot b. TO THE EXTENT POSSIBLE, IN NO EVENT WILL THE LICENSOR BE LIABLE
use both them and the Library together in an executable that you TO YOU ON ANY LEGAL THEORY (INCLUDING, WITHOUT LIMITATION,
distribute. NEGLIGENCE) OR OTHERWISE FOR ANY DIRECT, SPECIAL, INDIRECT,
INCIDENTAL, CONSEQUENTIAL, PUNITIVE, EXEMPLARY, OR OTHER LOSSES,
7. You may place library facilities that are a work based on the COSTS, EXPENSES, OR DAMAGES ARISING OUT OF THIS PUBLIC LICENSE OR
Library side-by-side in a single library together with other library USE OF THE LICENSED MATERIAL, EVEN IF THE LICENSOR HAS BEEN
facilities not covered by this License, and distribute such a combined ADVISED OF THE POSSIBILITY OF SUCH LOSSES, COSTS, EXPENSES, OR
library, provided that the separate distribution of the work based on DAMAGES. WHERE A LIMITATION OF LIABILITY IS NOT ALLOWED IN FULL OR
the Library and of the other library facilities is otherwise IN PART, THIS LIMITATION MAY NOT APPLY TO YOU.
permitted, and provided that you do these two things:
c. The disclaimer of warranties and limitation of liability provided
a) Accompany the combined library with a copy of the same work above shall be interpreted in a manner that, to the extent
based on the Library, uncombined with any other library possible, most closely approximates an absolute disclaimer and
facilities. This must be distributed under the terms of the waiver of all liability.
Sections above.
b) Give prominent notice with the combined library of the fact Section 6 -- Term and Termination.
that part of it is a work based on the Library, and explaining
where to find the accompanying uncombined form of the same work. a. This Public License applies for the term of the Copyright and
Similar Rights licensed here. However, if You fail to comply with
8. You may not copy, modify, sublicense, link with, or distribute this Public License, then Your rights under this Public License
the Library except as expressly provided under this License. Any terminate automatically.
attempt otherwise to copy, modify, sublicense, link with, or
distribute the Library is void, and will automatically terminate your b. Where Your right to use the Licensed Material has terminated under
rights under this License. However, parties who have received copies, Section 6(a), it reinstates:
or rights, from you under this License will not have their licenses
terminated so long as such parties remain in full compliance. 1. automatically as of the date the violation is cured, provided
it is cured within 30 days of Your discovery of the
9. You are not required to accept this License, since you have not violation; or
signed it. However, nothing else grants you permission to modify or
distribute the Library or its derivative works. These actions are 2. upon express reinstatement by the Licensor.
prohibited by law if you do not accept this License. Therefore, by
modifying or distributing the Library (or any work based on the For the avoidance of doubt, this Section 6(b) does not affect any
Library), you indicate your acceptance of this License to do so, and right the Licensor may have to seek remedies for Your violations
all its terms and conditions for copying, distributing or modifying of this Public License.
the Library or works based on it.
c. For the avoidance of doubt, the Licensor may also offer the
10. Each time you redistribute the Library (or any work based on the Licensed Material under separate terms or conditions or stop
Library), the recipient automatically receives a license from the distributing the Licensed Material at any time; however, doing so
original licensor to copy, distribute, link with or modify the Library will not terminate this Public License.
subject to these terms and conditions. You may not impose any further
restrictions on the recipients' exercise of the rights granted herein. d. Sections 1, 5, 6, 7, and 8 survive termination of this Public
You are not responsible for enforcing compliance by third parties with License.
this License.
11. If, as a consequence of a court judgment or allegation of patent Section 7 -- Other Terms and Conditions.
infringement or for any other reason (not limited to patent issues),
conditions are imposed on you (whether by court order, agreement or a. The Licensor shall not be bound by any additional or different
otherwise) that contradict the conditions of this License, they do not terms or conditions communicated by You unless expressly agreed.
excuse you from the conditions of this License. If you cannot
distribute so as to satisfy simultaneously your obligations under this b. Any arrangements, understandings, or agreements regarding the
License and any other pertinent obligations, then as a consequence you Licensed Material not stated herein are separate from and
may not distribute the Library at all. For example, if a patent independent of the terms and conditions of this Public License.
license would not permit royalty-free redistribution of the Library by
all those who receive copies directly or indirectly through you, then
the only way you could satisfy both it and this License would be to Section 8 -- Interpretation.
refrain entirely from distribution of the Library.
a. For the avoidance of doubt, this Public License does not, and
If any portion of this section is held invalid or unenforceable under any shall not be interpreted to, reduce, limit, restrict, or impose
particular circumstance, the balance of the section is intended to apply, conditions on any use of the Licensed Material that could lawfully
and the section as a whole is intended to apply in other circumstances. be made without permission under this Public License.
It is not the purpose of this section to induce you to infringe any b. To the extent possible, if any provision of this Public License is
patents or other property right claims or to contest validity of any deemed unenforceable, it shall be automatically reformed to the
such claims; this section has the sole purpose of protecting the minimum extent necessary to make it enforceable. If the provision
integrity of the free software distribution system which is cannot be reformed, it shall be severed from this Public License
implemented by public license practices. Many people have made without affecting the enforceability of the remaining terms and
generous contributions to the wide range of software distributed conditions.
through that system in reliance on consistent application of that
system; it is up to the author/donor to decide if he or she is willing c. No term or condition of this Public License will be waived and no
to distribute software through any other system and a licensee cannot failure to comply consented to unless expressly agreed to by the
impose that choice. Licensor.
This section is intended to make thoroughly clear what is believed to d. Nothing in this Public License constitutes or may be interpreted
be a consequence of the rest of this License. as a limitation upon, or waiver of, any privileges and immunities
that apply to the Licensor or You, including from the legal
12. If the distribution and/or use of the Library is restricted in processes of any jurisdiction or authority.
certain countries either by patents or by copyrighted interfaces, the
original copyright holder who places the Library under this License may add
an explicit geographical distribution limitation excluding those countries, =======================================================================
so that distribution is permitted only in or among countries not thus
excluded. In such case, this License incorporates the limitation as if Creative Commons is not a party to its public
written in the body of this License. licenses. Notwithstanding, Creative Commons may elect to apply one of
its public licenses to material it publishes and in those instances
13. The Free Software Foundation may publish revised and/or new will be considered the “Licensor.” The text of the Creative Commons
versions of the Lesser General Public License from time to time. public licenses is dedicated to the public domain under the CC0 Public
Such new versions will be similar in spirit to the present version, Domain Dedication. Except for the limited purpose of indicating that
but may differ in detail to address new problems or concerns. material is shared under a Creative Commons public license or as
otherwise permitted by the Creative Commons policies published at
Each version is given a distinguishing version number. If the Library creativecommons.org/policies, Creative Commons does not authorize the
specifies a version number of this License which applies to it and use of the trademark "Creative Commons" or any other trademark or logo
"any later version", you have the option of following the terms and of Creative Commons without its prior written consent including,
conditions either of that version or of any later version published by without limitation, in connection with any unauthorized modifications
the Free Software Foundation. If the Library does not specify a to any of its public licenses or any other arrangements,
license version number, you may choose any version ever published by understandings, or agreements concerning use of licensed material. For
the Free Software Foundation. the avoidance of doubt, this paragraph does not form part of the
public licenses.
14. If you wish to incorporate parts of the Library into other free
programs whose distribution conditions are incompatible with these, Creative Commons may be contacted at creativecommons.org.
write to the author to ask for permission. For software which is
copyrighted by the Free Software Foundation, write to the Free
Software Foundation; we sometimes make exceptions for this. Our
decision will be guided by the two goals of preserving the free status
of all derivatives of our free software and of promoting the sharing
and reuse of software generally.
NO WARRANTY
15. BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO
WARRANTY FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE LAW.
EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR
OTHER PARTIES PROVIDE THE LIBRARY "AS IS" WITHOUT WARRANTY OF ANY
KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE
LIBRARY IS WITH YOU. SHOULD THE LIBRARY PROVE DEFECTIVE, YOU ASSUME
THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
16. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN
WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY
AND/OR REDISTRIBUTE THE LIBRARY AS PERMITTED ABOVE, BE LIABLE TO YOU
FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR
CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE
LIBRARY (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING
RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A
FAILURE OF THE LIBRARY TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF
SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
DAMAGES.
END OF TERMS AND CONDITIONS
How to Apply These Terms to Your New Libraries
If you develop a new library, and you want it to be of the greatest
possible use to the public, we recommend making it free software that
everyone can redistribute and change. You can do so by permitting
redistribution under these terms (or, alternatively, under the terms of the
ordinary General Public License).
To apply these terms, attach the following notices to the library. It is
safest to attach them to the start of each source file to most effectively
convey the exclusion of warranty; and each file should have at least the
"copyright" line and a pointer to where the full notice is found.
<one line to give the library's name and a brief idea of what it does.>
Copyright (C) <year> <name of author>
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public
License as published by the Free Software Foundation; either
version 2.1 of the License, or (at your option) any later version.
This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public
License along with this library; if not, write to the Free Software
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301
USA
Also add information on how to contact you by electronic and paper mail.
You should also get your employer (if you work as a programmer) or your
school, if any, to sign a "copyright disclaimer" for the library, if
necessary. Here is a sample; alter the names:
Yoyodyne, Inc., hereby disclaims all copyright interest in the
library `Frob' (a library for tweaking knobs) written by James Random
Hacker.
<signature of Ty Coon>, 1 April 1990
Ty Coon, President of Vice
That's all there is to it!

View File

@ -1,9 +1,11 @@
# 6502 KiCad Library # RetroLib: KiCad Symbol Library for 6502 and related retro microchips
*Version 2.0.2* *Version 3.0.0*
Library of schematic components of a variety of Commodore, MOS Technologies and Wester Design Center chips for KiCad 6. ![Required KiCad Version](https://img.shields.io/badge/kicad-%3E%3D6.0-critical) ![License](https://img.shields.io/github/license/alarm-siren/6502-kicad-library) ![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/alarm-siren/6502-kicad-library) ![Symbols](https://img.shields.io/badge/symbols-53-informational) ![Downloads](https://img.shields.io/github/downloads/alarm-siren/6502-kicad-library/total)
Currently included are: This is a library of KiCad schematic symbols for a variety of Commodore, MOS Technology and Western Design Center retro microchips, including the eponymous MOS Technologies 6502.
Currently included microchips:
- 6502 8-bit NMOS Microprocessor, 64K, DIP-40 - 6502 8-bit NMOS Microprocessor, 64K, DIP-40
- 6503 8-bit NMOS Microprocessor, 4K, DIP-28 - 6503 8-bit NMOS Microprocessor, 4K, DIP-28
- 6504 8-bit NMOS Microprocessor, 8K, DIP-28 - 6504 8-bit NMOS Microprocessor, 8K, DIP-28
@ -62,36 +64,69 @@ Planned for future inclusion:
- The VIC, VIC-II and VIC-IIe - The VIC, VIC-II and VIC-IIe
- The TED - The TED
## Schematic Compatibility Between Similar Components ## KiCad Version Compatibility
This library requires at least KiCad 6 to function, and is tested on KiCad versions 6.0.8 and 7.0.2. Note that the installation procedure is different for KiCad 6 and 7; please see the [Library Installation](#library-installation) section below.
The schematic components in this library have been specifically laid out such that chips with similar function and purpose will have compatible/equivalent pins in the same position, and incompatible pins will not overlap. This means it should be easy to replace one similar component with another, with minimal or no re-wiring; it also means that such a replacement should not result in a signal being routed to an incompatible pin by accident.
For example, if you were creating a design with the 6502 part, but then decided to replace it with a 6512 part, the phase 0 and phase 2 pins are in the same location because they have compatible functionality, but the phase 1 pins are not because on the 6512 it is an input, whilst on the 6502 it is an output.
## Compatibility with KiCad 5
This library is in the new KiCad 6 "S-Expressions" format, and is not compatible with KiCad 5. If you need compatibility with KiCad 5, please use version 1.0.0 of this repository - but be aware that said version does not contain all features and is not being maintained.
## Comments, Requests, Bugs & Contributions ## Comments, Requests, Bugs & Contributions
All are welcome. All are welcome!
Please file an Issue or Pull Request at https://github.com/Alarm-Siren/6502-Kicad-library Please open an [Issue](https://github.com/Alarm-Siren/6502-Kicad-library/issues) or [Pull Request](https://github.com/Alarm-Siren/6502-Kicad-library/pulls), as appropriate.
## License ## Library Installation
Copyright 2018-2022, Nicholas Parks Young. All Rights Reserved. To install this library in your copy of KiCad, choose the correct section for your version of KiCad and follow the steps given. These instructions only cover automated installation using KiCad's built-in Package and Content Manager (PCM); manual installation is possible but not supported.
This library is licensed under the GNU LGPL v2.1, which can be found in file LICENSE.txt.
### KiCad 7
1. Download the `6502-kicad-library-3.0.0-pcm.zip` library file from the [Releases page](https://github.com/Alarm-Siren/6502-kicad-library/releases), and save it somewhere you'll be able to find it easily.
2. Open KiCad and open the Preferences window at "Preferences" -> "Preferences..."
3. Select the "Plugin and Content Manager" section in the left-hand pane.
4. Ensure that the "Automatically add installed libraries to the global lib table" option is ticked.
5. Ensuring that the "Library nickname prefix" is set to "PCM_" is recommended. **(Optional)**
6. Ensuring that the "Check for package updates on startup" option is ticked is recommended. **(Optional)**
7. Click "OK" to close the Preferences window.
8. Click the "Plugin and Content Manager" button.
9. Select the "KiCad official repository" from the top drop-down box (if not already selected).
9. Go the Libraries tab and locate the "KiCad Library for Arduino Modules" in the list.
10. Click the "Install" button for that entry in the list.
11. Click "Apply Pending Changes".
12. Close the "Applying Package Changes" window once it has finished.
13. You should now find that this library is listed in the "Installed" tab.
14. Close the Plugin and Content Manager.
15. You may need to restart KiCad for the library installation to fully take effect. **(Optional)**
16. All done: you are now ready to use these schematic components and footprints in your projects!
### KiCad 6
**Recommendation:** If you can, you should upgrade to KiCad 7.
1. Open KiCad and click the "Plugin and Content Manager" button.
2. Select the "KiCad official repository" from the top drop-down box (if not already selected).
3. Go the Libraries tab and locate the "KiCad Library for Arduino Modules" in the list.
4. Click the "Install" button for that entry in the list.
5. Click "Apply Changes".
6. Close the "Applying Package Changes" window once it has finished.
7. You should now find that this library is listed in the "Installed" tab.
8. Close the Plugin and Content Manager.
9. Go to the "Preferences" -> "Manage Symbol Libraries..." menu option.
10. In the Symbol Libraries dialogue that appears, switch to the "Global Libraries" tab (if not already selected).
11. Click "Add empty row to table" button (the button with a big cross in it, beneath the table).
12. In the new line of the table, set the Nickname to "PCM_arduino-library", and ensure the Library Format is set to "KiCad".
13. In the same line of the table, set Library Path to "${KICAD6_3RD_PARTY}/symbols/com_github_alarm-siren_arduino-kicad-library/arduino-library.kicad_sym".
14. Click "OK" to close the Symbol Libraries dialogue.
15. Go to "Preferences" -> "Manage Footprint Libraries..." menu option.
16. In the Footprint Libraries dialogue that appears, switch to the "Global Libraries" tab (if not already selected).
17. Click "Add empty row to table" button (the button with a big cross in it, beneath the table).
18. In the new line of the table, set the Nickname to "PCM_arduino-library", and ensure the Library Format is set to "KiCad".
19. In the same line of the table, set Library Path to "${KICAD6_3RD_PARTY}/footprints/com_github_alarm-siren_arduino-kicad-library/arduino-library.pretty".
20. Click "OK" to close the Footprint Libraries dialogue.
21. All done: you are now ready to use these schematic components and footprints in your projects!
## Donations ## Donations
If you've found this library useful and you'd like to make a donation towards its continued upkeep, click the button below: I really hope you've found this library useful. If you'd like to buy me a beer in thanks for the work I put into it, you can make a donation using the button below:
[![paypal](https://www.paypalobjects.com/en_GB/i/btn/btn_donate_LG.gif)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=UX25HM4CZFFWW) [![paypal](https://www.paypalobjects.com/en_GB/i/btn/btn_donate_LG.gif)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=UX25HM4CZFFWW)
## Library Setup ## FAQ Placeholder
To add this library to your KiCad Project, do the following steps:
1. Copy the source files "65xx.kicad_sym" to the root of your KiCad project's folder. No-one has asked any questions about this library yet. If they do so, this section will be updated.
2. In Schematic Editor go to the "Preferences" -> "Manage Symbol Libraries..." menu option.
3. In the Symbol Libraries dialogue that appears, switch to the "Project Specific Libraries" tab.
4. Click "Add empty row to table" button (the button with a big cross in it, beneath the table).
5. In the new line of the table, set Library Path to "${KIPRJMOD}\65xx.kicad_sym" on Windows or "${KIPRJMOD}/65xx.kicad_sym" on Linux/Mac, and ensure Plugin Type is "KiCad".
6. You can leave the Options and Description fields blank. You should set Nickname to something descriptive - for example, "65xx library".
7. All done: you are now ready to use these schematic components in your project!

31
metadata.json Normal file
View File

@ -0,0 +1,31 @@
{
"$schema": "https://go.kicad.org/pcm/schemas/v1",
"name": "RetroLib: KiCad Library for 6502-related retro microchips",
"description": "KiCad Symbol Library for 6502 and related retro microchips",
"description_full": "You may need to manually update the library tables in the Library Manager to get the new symbols and footprints to show up: please refer to the GitHub link below for full documentation and installation instructions.\n\nThis is a library of KiCad schematic symbols for a variety of Commodore, MOS Technology and Western Design Center retro microchips, including the eponymous MOS Technologies 6502.",
"identifier": "com.github.alarm-siren.arduino-kicad-library",
"type": "library",
"author": {
"name": "Nicholas Parks Young",
"contact": {
"web": "https://github.com/Alarm-Siren/"
}
},
"license": "CC-BY-SA-4.0",
"resources": {
"github": "https://github.com/Alarm-Siren/6502-kicad-library"
},
"tags": [
"footprints",
"symbols",
"arduino",
"modules"
],
"versions": [
{
"version": "3.0.0",
"status": "testing",
"kicad_version": "6.0"
}
]
}