Skip to content

Commit

Permalink
Improve README
Browse files Browse the repository at this point in the history
Signed-off-by: Diamond Rivero <[email protected]>
  • Loading branch information
diamant3 authored Feb 11, 2024
1 parent 00006fb commit d142403
Showing 1 changed file with 11 additions and 16 deletions.
27 changes: 11 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,13 @@
![banner](res/banner.png)

# Introduction
Small and simple GUI tool to gather your computer's information using Python.
[![Pylint](https://github.com/diamant3/SYSIG/actions/workflows/Pylint.yml/badge.svg)](https://github.com/diamant3/SYSIG/actions/workflows/Pylint.yml)

## Introduction

This is a small and simple GUI tool to gather your computer's information using Python.

## Demo

https://github.com/diamant3/SYSIG/assets/71203851/b0454b5e-e3cb-4050-8f3c-853fb65eed16

## Run

Upgrade pip then install required modules:

```shell
Expand All @@ -25,19 +21,18 @@ then run:
python sysig.py
```

> **Note**
> [!Important]
> If you see a `ModuleNotFoundError: No module named 'distutils'` error, please install
> setuptools using the command `python -m pip install setuptools`.
> [!Note]
> This is just a hobby project and all information you will see in the app is based on the Python modules's detection capabilities. Thank you for your understanding!
## Credits

[Hardware detection in python](https://www.thepythoncode.com/article/get-hardware-system-information-python)

[psutil](https://github.com/giampaolo/psutil)

[DearPyGUI](https://github.com/hoffstadt/dearPyGui/)

[py-cpuinfo](https://github.com/workhorsy/py-cpuinfo)
- [Hardware detection in python](https://www.thepythoncode.com/article/get-hardware-system-information-python)
- [psutil](https://github.com/giampaolo/psutil)
- [DearPyGUI](https://github.com/hoffstadt/dearPyGui/)
- [py-cpuinfo](https://github.com/workhorsy/py-cpuinfo)

## Contribute

Open for any type of contribution, thanks!

0 comments on commit d142403

Please sign in to comment.