summaryrefslogtreecommitdiffstats
path: root/browser/branding/docs
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-07 19:33:14 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-07 19:33:14 +0000
commit36d22d82aa202bb199967e9512281e9a53db42c9 (patch)
tree105e8c98ddea1c1e4784a60a5a6410fa416be2de /browser/branding/docs
parentInitial commit. (diff)
downloadfirefox-esr-36d22d82aa202bb199967e9512281e9a53db42c9.tar.xz
firefox-esr-36d22d82aa202bb199967e9512281e9a53db42c9.zip
Adding upstream version 115.7.0esr.upstream/115.7.0esrupstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to '')
-rw-r--r--browser/branding/docs/UpdatingMacIcons.rst31
-rw-r--r--browser/branding/docs/index.rst22
2 files changed, 53 insertions, 0 deletions
diff --git a/browser/branding/docs/UpdatingMacIcons.rst b/browser/branding/docs/UpdatingMacIcons.rst
new file mode 100644
index 0000000000..b55d80cffe
--- /dev/null
+++ b/browser/branding/docs/UpdatingMacIcons.rst
@@ -0,0 +1,31 @@
+.. _updatingmacicons:
+
+====================
+Updating macOS Icons
+====================
+
+macOS icons are stored as ``icns`` files that contain the same logo in multiple different sizes and DPIs. Apple's `Human Interface Guidelines <https://developer.apple.com/design/human-interface-guidelines/foundations/app-icons>`_ should be consulted for the specifics.
+
+Although it may seem like we can simply be handed the highest resolution/DPI version and downscale for the remainder -- this is not the case, some finer details in the icons (most notably shadows) need to be tweaked for each size. The UX team should hand off PNGs for every size and DPI needed.
+
+Once those are in hand, the ``icns`` file can be created with something like the following:
+
+::
+
+ mkdir firefox.iconset
+ mv icon_16x16.png firefox.iconset
+ mv icon_32x32.png firefox.iconset
+ mv icon_32x32@2x.png firefox.iconset
+ mv icon_64x64@2x.png firefox.iconset
+ mv icon_128x128.png firefox.iconset
+ mv icon_256x256 firefox.iconset
+ mv icon_256x256@2x.png firefox.iconset
+ mv icon_512x512.png firefox.iconset
+ mv icon_512x512@2x.png firefox.iconset
+ mv icon_1024x1024@2x.png firefox.iconset
+ iconutil -c icns firefox.iconset
+
+
+(The ``NxN`` part is obviously the resolution, and the ``@2x`` string is used in the high DPI versions.)
+
+This will create a ``firefox.icns`` file. You can verify that it includes all of the necessary resolutions and DPIs by inspecting it with ``Preview.app``. You will likely need to do this for all brandings (``official``, ``aurora``, ``nightly``, and ``unofficial`` at the time of writing).
diff --git a/browser/branding/docs/index.rst b/browser/branding/docs/index.rst
new file mode 100644
index 0000000000..23e07fbd60
--- /dev/null
+++ b/browser/branding/docs/index.rst
@@ -0,0 +1,22 @@
+Firefox Branding
+================
+
+Firefox has multiple different sets of "branding" that are used to hold channel-specific things such as:
+* Logos and other iconography
+* Product names (eg: "Mozilla Firefox", "Firefox Developer Edition")
+* Channel-specific preferences (eg: ``app.update.interval``)
+
+Brandings are stored in the `branding subdirectory <https://searchfox.org/mozilla-central/source/browser/branding>`_ and map to builds as follows:
+
+- ``official`` is used for Release and Beta builds
+- ``aurora`` is used for Developer Edition builds
+- ``nightly`` is used for Nightly and Try builds
+- ``unofficial`` is used when no other branding is specified (eg: local developer builds)
+
+
+Additional reading
+------------------
+
+.. toctree::
+
+ UpdatingMacIcons