artin/sourcegraph
1
0
Fork 0
mirror of https://github.com/sourcegraph/sourcegraph.git synced 2026-02-06 18:51:59 +00:00
Code Issues Packages Projects Releases Wiki Activity

App docs: Update readme with documentation about icons (#53563)

Browse Source 
Add documentation about Tauri icons to the App readme.

This explains how the icons work and how to generate the different size
and format variants.

## Test plan

- Documentation change only

---------

Co-authored-by: Juliana Peña <me@julip.co>
This commit is contained in:
Marek 2023-06-20 09:31:54 -04:00 committed by GitHub
parent 66ff3a5eed
commit 86e4736807
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 25 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
src-tauri/README.md
View File

@ -51,6 +51,31 @@ To start the app in 'dev' mode you need to run the following command:
- `sg start app`
- `pnpm tauri build` this will build the complete Tauri bundle, which, if you're on mac, will be called `Cody.dmg`. The other noticeable difference is that is will run the `client/app-shell` code.
## Updating the icons
### Application icons
The application icon is defined in the `tauri.bundle.icon` field in `tauri.conf.json` and the files are located in `src-tauri/icons`. The application icon is one icon image, but is made available in multiple sizes and formats.
Do not create the sizes and formats manually for the application icon. Instead, use the `tauri icon` command.
```
cd src-tauri
tauri icon icon.png
```
The input file, `icon.png`, is expected to be a full-size PNG with transparency. It's recommended to be 1024x1024 in size.
The `tauri icon` command will generate all of the variants and sizes automatically, and place them in `src-tauri/icons`.
### System tray icon
The system tray icon is different from the application icon. It's placed in `icons/tray.png` and defined in `tauri.systemTray.iconPath`.
The tray icon is expected to be grayscale and will automatically be adjusted between light and dark modes. This behavior is enabled by the `iconAsTemplate` flag.
Note that the light and dark versions of the tray icon depend on the color of the desktop wallpaper, and not on the system UI light/dark theme.
## Where to get help or support
You can join us in Slack! We have a few channels that you might be interested in: