aboutsummaryrefslogtreecommitdiff
path: root/addons.mozilla.org-fsd/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'addons.mozilla.org-fsd/README.md')
-rw-r--r--addons.mozilla.org-fsd/README.md28
1 files changed, 28 insertions, 0 deletions
diff --git a/addons.mozilla.org-fsd/README.md b/addons.mozilla.org-fsd/README.md
new file mode 100644
index 0000000..73d1301
--- /dev/null
+++ b/addons.mozilla.org-fsd/README.md
@@ -0,0 +1,28 @@
+################################################################################
+About this project
+
+This project has been developed to syncronize free WebExtensions (WE) data from addons.mozilla.org entries to the Free Software Directory entries (https://directory.fsf.org/wiki/Collection:IceCat), example https://addons.mozilla.org/en-US/firefox/addon/librejs/ with https://directory.fsf.org/wiki/LibreJS. See `About WebExtensions` why legacy add-ons are excluded.
+
+This script uses the Mozilla add-on API (https://addons-server.readthedocs.io/en/latest/topics/api/addons.html), and decides what to do with add-ons distributed under a free license. A lot of developers have added a license on the addons.mozilla.org page for their add-on but are not aware of the common guidelines to make their programs fully free because Mozilla never informed them about it. Common issues:
+* COPYING or LICENSE file in the root directory for example.
+* There are no (full) license notices in the non-trivial source files
+
+Add-ons that doesn't have these issues will get generated XML files that can be synced to the Free Software Directory while add-ons that has these issues will generated on a list so we can contact the developers and ask them to fix them.
+
+I've decided to set the uppder limit for WebExtensions to have 10 000 daily users or more so we have a chance to work on the most relevant add-ons since there are many thousands of add-ons on addons.mozilla.org. However a few add-ons that has less than 10 000 daily users are highly relevant (for example https://addons.mozilla.org/en-US/firefox/addon/librejs/ at this writing) so the script will be able to include add-ons from customized so called Collections from addons.mozilla.org (example, https://addons.mozilla.org/en-US/firefox/collections/DavidHedlund/) where they can be managed, or from a simple text document that lists the addons.mozilla.org URL's.
+
+
+################################################################################
+About WebExtensions
+
+GNU IceCat 60 is based on Firefox ESR 60 which is the first Fireofox ESR version based on Firefox Quantum (Firefox 57+). Firefox Quantum removed support for legacy add-ons and only run WebExtension add-ons. WebExtensions is a new browser extension compatible with the extensions APIs of Google Chrome and Microsoft Edge.
+
+################################################################################
+About GNU IceCat
+
+GNU IceCat aim to be based on the the current official release of Firefox Extended Support Release (ESR) with removal of trademarked artwork and proprietary components.
+
+However, IceCat is not a straight fork of Firefox ESR; instead, it is a parallel effort that works closely with and re-bases in synchronization on the latest Firefox ESR as the upstream supplier, with patches merged upstream whenever possible; although it should be noted that additional security updates are customized to IceCat occasionally.
+
+IceCat -> Tools -> Add-ons (about:addons) -> Get Add-ons -- this page could use https://directory.fsf.org/wiki/Collection:IceCat?&printable=yes in the future
+