Skip to content

Commit 9de1825

Browse files
Update README.md
Gave a description about current features
1 parent 83eb8d8 commit 9de1825

File tree

1 file changed

+5
-12
lines changed

1 file changed

+5
-12
lines changed

README.md

Lines changed: 5 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -24,26 +24,19 @@ This is a Python script that uses the Pygame library to display the current FPS
2424
* Run the script using `python FPS-Monitor.py`
2525

2626

27-
<h2>Usage :movie_camera: </h2>
28-
29-
The script will display the current FPS in the top left corner of the window. The GPU and CPU usage will be displayed on the right side of the window.
30-
31-
You can resize the window to your desired size by clicking and dragging the edges of the window.
32-
33-
To exit the script, simply close the window or press the 'X' button in the top right corner of the window.
34-
3527
<h2>Limitations :warning: </h2>
3628

3729
This script is only compatible with NVidia GPUs. It will not work with other types of GPUs such as AMD or Intel. Additionally, it will only display information for the first GPU it detects. If you have multiple GPUs installed, you will need to modify the script to display information for all of them.
3830

3931

4032
<h2>Features :space_invader: </h2>
41-
42-
You can customize the script to display additional information such as GPU memory usage or CPU temperature. You can also change the font, text color and background color of the window to match your personal preferences.
33+
This code is a Python script that uses Pygame, sys, psutil, gpustat, and cpuinfo libraries to display system information in a graphical interface. The code initializes the Pygame library, sets the height and width of the window, and sets up a font for text display. <br>
4334
<br>
35+
The script has several functions that are responsible for getting specific system information and returning text in the form of a Pygame surface. The fpsrun() function returns the current FPS value as text. <br>
36+
<br> The get_cpu_usage() function returns the CPU usage percentage, along with the CPU name, in text format with different colors depending on whether the CPU is from AMD, Intel, or any other brand. <br>
37+
<br> The get_gpu_usage() and get_gpu_name() functions return the GPU usage percentage and name in text format with green color. The get_ram_info() and get_ram_usage() functions return the total RAM and the RAM usage percentage in text format with orange color.
4438

45-
Currently in testing: Color changing depending on having AMD or Intel.
46-
AMD goes red, while Intel goes blue
39+
<br> In the main loop, the script listens for Pygame quit events, updates the screen with the system information, and updates the display 60 times per second. The script displays the FPS value, CPU name, CPU usage, GPU name, GPU usage, total RAM, and RAM usage on the screen.
4740

4841
<h2>Roadmap :calendar: (subject to change)</h2>
4942

0 commit comments

Comments
 (0)