Skip to content

Commit

Permalink
Merge pull request #46 from slytomcat/dev
Browse files Browse the repository at this point in the history
fix readme
  • Loading branch information
slytomcat authored Dec 27, 2024
2 parents 9420c2c + 100b926 commit e75fe54
Show file tree
Hide file tree
Showing 3 changed files with 19 additions and 18 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ Application uses settings from the configuration file. The default path to confi
- `"Theme"` - Icons theme name (default `"dark"`, may be set to `"dark"` or `"light"`). This setting can be changed via indicator menu.
- `"Notifications"` - Display or not the desktop notifications (default `true`). This setting can be changed via indicator menu.
- `"StartDaemon"` - Flag that shows that the daemon should be started on app start (default `true`). This setting can be changed via indicator menu.
- `"StopDaemon"` - Flag that shows that the daemon should be stopped on app closure (defaul `false`). This setting can be changed via indicator menu.
- `"StopDaemon"` - Flag that shows that the daemon should be stopped on app closure (default `false`). This setting can be changed via indicator menu.

## Get
Download linux-amd64 binary from [releases](https://github.com/slytomcat/yd-go/releases), copy it to path in PATH (/usr/local/bin for example) and make it executable.
Expand Down Expand Up @@ -77,4 +77,4 @@ NOTE: the yandex-disk CLI utility must be installed and configured before starti

## Icons

All the indicator icons are embedded into binary during the build time. But You can change them and rebuild the indicator. See more details about icons into [icons/img/readme](icons/img/readme)
All the indicator icons are embedded into binary during the build time. But You can change them and rebuild the indicator. See more details about icons into [icons/img/readme.md](icons/img/readme.md)
16 changes: 0 additions & 16 deletions icons/img/readme

This file was deleted.

17 changes: 17 additions & 0 deletions icons/img/readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
Icons are used to display the indicator statuses.

There are two icons themes:
- `dark*` - for dark panel
- `light*` - for light panel

Each theme must support the following set of icons:
- `*Idle.png` - displayed when Yandex.disk is synchronized
- `*Pause.png` - displayed when Yandex.disk daemon not started or synchronization is paused
- `*Error.png` - displayed when some error occurs in synchronization
- `*Busy[1-5].png` - set of icons to indicate the synchronization process.

Icons `*Busy[1-5].png` are displayed sequentially in the loop (to simulate animation):

`*Busy1.png` -> `*Busy2.png` -> `*Busy3.png` -> `*Busy4.png` -> `*Busy5.png` -> `*Busy1.png` -> `*Busy2.png` ...

The special big icon `yd128.png` is used into about dialogue and into notifications.

0 comments on commit e75fe54

Please sign in to comment.