Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Silun authored Dec 30, 2020
1 parent d365037 commit 77c888a
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Trayify
A small utility to hide and create a tray icon for any program's window.
A small windows utility to hide and create a tray icon for any program's window.

## Installation
Trayify is strictly a _windows_ utility. You may download the compiled executable or use the script inside a Python environment.
Expand All @@ -13,7 +13,7 @@ There are two ways to run Trayify:
- Put the script or compiled executable into a directory that contains exactly one executable other than Trayify itself, and run it without any additional arguments.
- Run Trayify and pass exactly one argument, which should be the path to the executable which you want to use Trayify on.<br/>Example: `\Path\to\Trayify.exe \Path\to\other\exe`

If you want the tray icon to be something specific, create an `.ico` file of the same name as the executable you want to run in the same directory, for example: `Run-me.exe` for the executable and `Run-me.ico` for its icon file. If no icon file is present or it can't be read, the standard Python icon will be used instead.
If you want the tray icon to be something specific, create an `.ico` file of the same name as the executable you want to run in the same directory, for example: `Run-me.exe` for the executable and `Run-me.ico` for its icon file, located right next to each other. If no icon file is present or it can't be read, the standard Python icon will be used instead.

## Behaviour of Trayify
Trayify will run the target program with its window hidden, and create a tray icon in its place. Either double-clicking or right-clicking the icon and then choosing `Toggle` will bring up and hide the window, respectively. When `Exit` is chosen from the menu, Trayify will attempt to close the program via a `SIGTERM` signal.

0 comments on commit 77c888a

Please sign in to comment.