docs(readme): add simple readme

This commit is contained in:
2025-06-29 03:29:51 +01:00
parent e47cdf1dcf
commit 6439cf95ae

68
README.md Normal file
View File

@@ -0,0 +1,68 @@
<p align="center">
<img width="512px" src="https://raw.githubusercontent.com/jimeh/emacs-liquid-glass-icons/refs/heads/main/img/logo.png" alt="Logo">
</p>
<h1 align="center">
Emacs Liquid Glass Icons
</h1>
<p align="center">
<strong>
Emacs app icons in macOS 26's new Liquid Glass style.
</strong>
</p>
## The Icons
### EmacsLG1
EmacsLG1 simplifies and changes the outer shape of the default icon to comply
with the shape of Liquid Glass icons.
![EmacsLG1 Preview](https://raw.githubusercontent.com/jimeh/emacs-liquid-glass-icons/refs/heads/main/img/preview-lg1.png)
### EmacsLG2
EmacsLG2 stays as close to the original round icon as possible, while giving it
that Liquid Glass flair.
![EmacsLG1 Preview](https://raw.githubusercontent.com/jimeh/emacs-liquid-glass-icons/refs/heads/main/img/preview-lg2.png)
### EmacsLG3
EmacsLG3 is the biggest divergence from Emacs' default icon, and is inspired by
the changes Apple has made to some of its own icons in macOS 26.
![EmacsLG1 Preview](https://raw.githubusercontent.com/jimeh/emacs-liquid-glass-icons/refs/heads/main/img/preview-lg3.png)
## Usage
### macOS 15 and earlier
Grab the `.icns` file you prefer from the `Resources` directory, and replace
`Contents/Resources/Emacs.icns` within your Emacs.app.
You may need to rename the Emacs app to something else (like "EmacsX") and then
back again to "Emacs" for the icon change to take immediate effect.
### macOS 26
On macOS 26, the icons support light/dark mode, clear glass mode, and custom
color tints as well. However, this works a bit different from the old `.icns`
files.
Grab the `Assets.car` from the `Resources` directory, and place it into
`Contents/Resources` within your Emacs.app.
Then edit `Contents/Info.plist`, and add the following:
```plist
<key>CFBundleIconName</key>
<string>EmacsLG1</string>
```
Set the value to one of `EmacsLG1`, `EmacsLG2`, or `EmacsLG3` depending on which
icon you want to use. All three are contained in the `Assets.car` file.
The existing `Contents/Resources/Emacs.icns` file with the original icon can be
left alone.