From ac7884a0d74ddfe4dec972e3bcc185f72ac50615 Mon Sep 17 00:00:00 2001 From: Aether <36291026+imAETHER@users.noreply.github.com> Date: Sun, 6 Aug 2023 05:12:07 +0000 Subject: [PATCH] Update README.md --- README.md | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 4677690..4c52e35 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,17 @@ -#

PC Stats

+#

PC Stats
![image](https://github.com/imAETHER/PCStats/assets/36291026/28eed7b1-5a0e-41a0-8aa7-d990ea16acc8)

- -# 🟢 Usage +# ✨ Usage Either build it yourself or go to [releases](https://github.com/imAETHER/PCStats/releases) and download it. This project uses OSHI to get processor temperatures, OSHI uses [OpenHardwareMonitor](https://openhardwaremonitor.org/) to get these, download and run it in the background while you use the RPC to get accurate readings.
-- Place the jar in a folder -- Open CMD/Windows Terminal(looks better) and execute the jar with the command: -`java -jar PCStats.jar` -- It will automatically create config.json in the current directory and will ask you which gpu you want to use **(for the display name only)** -- Will auto save the config when you close the program by doing CTRL + C -- You can manually edit the config to change selected gpu, show uptime and change the RPC images/gifs +- Make a folder and place the jar in there +- Open the jar (with java 8 or above) +- It will automatically create `config.json` in the current directory and will open the GUI! +- You can now edit the RPC as you wish + - Once the RPC is running you can click the close button to minimize it to tray, click the tray icon to bring PCStats back up. + - To close it click "Stop RPC" and then you can close it normally. +- Configs are automatically saved on exit # 💻 Supported platforms All platforms since its java & its using OSHI (haven't tested tho), for now GPU usage and temperature **only works with NVIDIA gpus that have nvidia-smi**.