Merge pull request #4 from git-user-cpp/main

merging with main

Author: git-user-cpp

README.md

@@ -1,5 +1,7 @@
 # spynix
-unix system info scraper
+unix system & hardware info scraper
+
+---
 
     Copyright 2024 Andrew Kushyk
 
@@ -9,6 +11,8 @@ unix system info scraper
         
         http://www.apache.org/licenses/LICENSE-2.0
 
+---
+
 | Downloads | Stars |
 |---|---|
 | ![GitHub all releases](https://img.shields.io/github/downloads/git-user-cpp/spynix/total?color=00FF00&label=Downloads&logo=GitHub&logoColor=00FF00&style=plastic) | ![GitHub Repo stars](https://img.shields.io/github/stars/git-user-cpp/spynix?color=FFFF00&label=Stars&logo=GitHub&logoColor=FFFF00&style=plastic) |
@@ -24,3 +28,27 @@ unix system info scraper
 | Activity | Last commit|
 |---|---|
 | ![GitHub commit activity](https://img.shields.io/github/commit-activity/y/git-user-cpp/spynix?color=98FB98&label=Commit%20activity&logo=GitHub&logoColor=98FB98&style=plastic) | ![GitHub last commit](https://img.shields.io/github/last-commit/git-user-cpp/spynix?color=98FB98&label=Last%20commit&logo=GitHub&logoColor=98FB98&style=plastic) |
+
+---
+
+## How to use this app
+
+1) **The program is designed for Debian, so avoid using other distributions and systems or redesign the program to avoid errors.**
+
+2) Download *all* files and put them in a one directory.
+
+3) Enter the directory.
+   ```
+   cd /path_to/spynix
+   ```
+
+4) Compile and run the program with *clang*.
+    - Compilation example
+    ```
+    clang -W -o spynix src/main.c 
+    ```
+5) Launch the app to see all available options.
+    ```
+    ./spynix --help
+    ```
+---