iicd/Inkycal
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Updated folder structure

Browse Source
This commit is contained in:
Ace 2020-05-15 03:06:41 +02:00 committed by GitHub
parent 1f90a186d3
commit c01a17632a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 32 additions and 30 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

62
README.md
View File

@ -20,36 +20,38 @@ The main folder is now inkcal.
Folder structure: Folder structure:
```bash ```bash
│ Inkycal.py -main file (work in progress) | Inkycal.py -main file (work in progress)
│ __init__.py | __init__.py
│ |
├───configuration -handles parsing, validation etc. of settings.json file +---config
│ settings.json -Sample settings file | layout.py -handles layout of image (size, section-sizes)
│ settings_parser.py -parses settings.json file | parser.py -parse the settings.json file
│ __init__.py | settings.json -JSON file for all the user-config
│ | __init__.py
├───display - Handles everything replated to the display |
│ │ layout.py - Set page layout +---custom
│ │ __init__.py | functions.py -custom functions of inkycal-software (writing text, etc..)
│ │ | __init__.py
│ ├───drivers - driver files for supported ePaper displays |
│ │ epdconfig.py +---display
│ │ epd_4_in_2.py | | __init__.py
│ │ epd_4_in_2_colour.py | |
│ │ epd_5_in_83.py | \---drivers - drivers....
│ │ epd_5_in_83_colour.py | epdconfig.py
│ │ epd_7_in_5.py | epd_4_in_2.py
│ │ epd_7_in_5_colour.py | epd_4_in_2_colour.py
│ │ epd_7_in_5_v2.py | epd_5_in_83.py
│ │ epd_7_in_5_v2_colour.py | epd_5_in_83_colour.py
│ │ __init__.py | epd_7_in_5.py
│ | epd_7_in_5_colour.py
├───modules - folder containing all supported modules | epd_7_in_5_v2.py
│ inkycal_rss.py - inkycal_rss module | epd_7_in_5_v2_colour.py
│ __init__.py | __init__.py
│ |
└───render - Contains file to help with rendering \---modules - folder containing all modules
functions.py - Inky-Calendar custom functions ical_parser.py - parses icalendars
inkycal_rss.py - parses rss feeds
inkycal_weather.py - parses weather from openweathermap
__init__.py __init__.py
``` ```