Skip to content
This repository has been archived by the owner on Jun 20, 2021. It is now read-only.

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
One code file was fun while it lasted
  • Loading branch information
TheGuardianWolf committed Jan 1, 2020
1 parent acc3ab9 commit 2adc89c
Showing 1 changed file with 37 additions and 2 deletions.
39 changes: 37 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@ Tested on Windows 10.

Get the releases [here](https://github.com/TheGuardianWolf/ThunderbirdTray/releases).

An updater (ThunderbirdTrayUpdater.exe) is available to automatically download new releases. Simply run this and it will automatically download the right ZIP file and extract it for you.

The releases are seperated into a few versions for compatiblity reasons.

* NET Framework - Requires .NET Framework 4.6.1 runtime, preinstalled on Windows 10. **Recommended**.
Expand All @@ -32,6 +34,8 @@ if it is not already launched when the tray app is launched.

## How do I use this?

### ThunderbirdTray

Either launch the exe manually or put it in your startup folder to launch on login.

To launch on startup:
Expand All @@ -40,6 +44,31 @@ To launch on startup:
2. Type ```shell:startup```.
3. Place a shortcut of the exe into the folder.

To start in debug mode for additional logging:

1. Open Powershell and locate the folder where ThunderbirdTray is.
2. Type ```.\ThunderbirdTray.exe --debug```
3. Check for the log.txt file in the working directory

Alternatively place ```launch_debug.bat``` in the same directory as ThunderbirdTray and run it.

### ThunderbirdTrayUpdater

This is a console application, either run it with default settings and follow the prompts, or use the CLI as follows:

```bash
usage: Updater for ThunderbirdTray (v1.0.0). [-h] [-v] [-d DIR] [-f] [-p]
[--draft]

optional arguments:
-h, --help show this help message and exit
-v, --verbose Enable debug output.
-d DIR, --dir DIR
-f, --force Will download latest regardless of current version.
-p, --pre Allow pre-releases.
--draft Allow drafts.
```

## How does it work?

The application will start Thunderbird if it is not already started in a minimised state. From then on,
Expand All @@ -50,6 +79,9 @@ To exit, right click the tray application and click exit. This will not close Th

Closing Thunderbird however will close this application.

Starting Thunderbird does not start this application though, this application is intended to be started in lieu of
Thunderbird.

### HELP I CAN'T FIND THUNDERBIRD

If you've somehow lost the Thunderbird window and/or the application crashes, simply open thunderbird manually
Expand All @@ -74,8 +106,11 @@ I'd settle it once and for all (I hope) by not using WebExtensions and relying o

There is also another Win32 application [TBTray](https://github.com/sagamusix/TBTray) that does
something simillar, but this is achieved through Dll injection. I believe it is an ugly way to
accomplish this relatively simple task that can be more elegantly and concisely tackled (I do
it in one code file!). Furthermore, that application has limitations that this one does not.
accomplish this relatively simple task that can be more elegantly and concisely tackled. Furthermore,
that application has limitations that this one does not.

There is also [birdtray](https://github.com/gyunaev/birdtray), which I have not personally used but from the looks
of the project, it may be worth trying out if you're looking for something a bit more sophisticated.

## I've got suggestions (or a bug)!

Expand Down

0 comments on commit 2adc89c

Please sign in to comment.