Skip to content

Commit

Permalink
better readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Neuroburst committed Apr 3, 2024
1 parent c8cfda9 commit ebd674c
Showing 1 changed file with 20 additions and 9 deletions.
29 changes: 20 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,32 +1,43 @@
# PowerTray
Welcome! PowerTray is a simple battery monitor that sits in your system tray!
The tooltip also displays useful information.
You can also right click on the icon>Click "Battery Info" to see even more information!
You can also right click on the icon > Click "Battery Info" to see even more information!

## Features
- Displays customizable information in the system tray
- Displays battery capacity, charge, and status
- Displays battery capacity, charge, lifetime, and status
- Allows you to see more advanced information, like voltage, design capacity, and battery health
- Calculates discharge and charge rate manually for a more accurate reading than the system
- Uses minimal resources and stays out of your way
- Graphs discharge rates and CPU & GPU power usage
- Tray, tooltip, and battery information updates frequently
- Customizable tray display
- And so much more!

## Installation

1. Make sure you have .NET 8.0 installed! (or use the self contained version of powertray)
1. Make sure you have .NET 8.0 installed! (or use the self contained version of PowerTray)
2. Download the latest release
3. To get to your startup folder, press Windows+R, type "shell:startup", then press enter
4. Put PowerTray.exe in that folder
5. It will now run every time your computer starts up!

(Admin access is required to graph CPU and GPU power usage, so you can make a shortcut in the startup folder that runs Powertray as admin)
### If you don't want PowerTray to run as admin
3. To get to your startup folder, press Windows+R, type "shell:startup", then press enter
4. Put PowerTray.exe in that folder
5. It will now run every time your computer starts up!

### If you do want PowerTray to run as admin (allows graphing of CPU and GPU power usage)
3. Put PowerTray into any desired folder (don't move it again otherwise the shortcut will break!)
4. Open the startup folder by pressing Windows+R, typing "shell:startup", then pressing enter
5. Create a shortcut of PowerTray in that folder
6. Right click the shortcut and click properties
7. Go to the Compatibility section and check "Run this program as administrator"
8. Click OK
9. It will now run as admin every time your computer starts up!



## Creation
This is an open-source project created with Visual Studio.
It was made using the .NET framework and WPF.

Support for Windows 10 & 11
Supports Windows 10 & 11

I used some components from LibreHardware Monitor to detect more battery information.

0 comments on commit ebd674c

Please sign in to comment.