Skip to content

Commit

Permalink
Merge pull request #6 from Saibamen/readme
Browse files Browse the repository at this point in the history
Update readme
  • Loading branch information
hedihadi authored Apr 19, 2024
2 parents db0f826 + 72fe65c commit 25b2f4a
Showing 1 changed file with 9 additions and 11 deletions.
20 changes: 9 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,23 +2,21 @@

Zal uses Python, C#, Dart & Flutter under the hood.

## Why 4 Folders? Well...
## Folder Structure

| Folder | Description |
| ------------ | -------------------------------------------------- |
| zal_app | source code for Zal application for Android & IOS. |
| zal_program | the front-end of Zal for Windows. |
| zal_console | the back-end of Zal for Windows. |
| task_manager | used to get data about running processes. |
| python_scripts | this folder contains some python scripts. the scripts are converted into executables and used as resources inside zal_program|
| zal_app | Source code for Zal application for Android & IOS. |
| zal_program | The front-end and back-end of Zal for Windows. |

Zal uses C# to collect the data from your PC, but due to my lack of skillset with C#, i had to use Flutter & Dart for the Design.
the build folder is inside `zal_program/assets/executables/zal-console/` and from there zal_program will run the C# application.
Zal uses C# to collect the data from your PC, but due to my lack of skillset with C#, I had to use Flutter & Dart for the Design.

## Sources

Zal uses a variety of other applications and combine them all into one Application. the list below are the Application that `zal_console` uses under the hood.
Zal uses a variety of other applications and combine them all into one Application. The list below are the Application that `zal_console` uses under the hood.
| Application | Description |
| ------ | ------ |
| [Librehardwaremonitor](https://github.com/LibreHardwareMonitor/LibreHardwareMonitor) | used to retrieve temperature, loads, network usage, etc... |
| [presentmon](https://github.com/GameTechDev/PresentMon) | used to get FPS data from Game applications. |
| [Crystaldiskinfo](https://crystalmark.info/en/software/crystaldiskinfo/) |used to get Storage data. |
| [Librehardwaremonitor](https://github.com/LibreHardwareMonitor/LibreHardwareMonitor) | Used to retrieve temperature, loads, network usage, etc... |
| [presentmon](https://github.com/GameTechDev/PresentMon) | Used to get FPS data from Game applications. |
| [Crystaldiskinfo](https://crystalmark.info/en/software/crystaldiskinfo/) | Used to get Storage data. |

0 comments on commit 25b2f4a

Please sign in to comment.