Create README.md

This commit is contained in:
Roland Beck
2023-05-25 13:53:08 +10:00
committed by GitHub
parent 0db7521bee
commit fd50ab7deb

14
pialert/README.md Normal file
View File

@@ -0,0 +1,14 @@
# Pi.Alert all split into modules
I am trying to split this big original file into modules and gives me some nice challanges to solve.
Since the original code is all in one file, the original author has taken quite some shortcuts by defining lots of variables as global !!
These need to be changed now.
Here is the main structure
| Module | Description |
|--------|-----------|
|pialert.py | The MAIN program of Pi.Alert|
|const.py | A place to define the constants for Pi.Alert like log path or config path.|
|const.py| const.py holds the configuration variables and makes them availabe for all modules. It is also the <b>workaround</b> for the global variables until I can work them out|
|api.py| |