diff --git a/README.md b/README.md index 10bc1d9..24d8cc5 100644 --- a/README.md +++ b/README.md @@ -270,10 +270,60 @@ With your setup being complete at this stage, you may want to 3d-print a case. T friendly community: [3D-printable case](https://github.com/aceinnolab/Inkycal/wiki/3D-printable-files) +## Directory structure +```tree +├── __init__.py +├── custom (custom functions of Inkycal are inside here) +│   ├── __init__.py +│   ├── functions.py +│   ├── inkycal_exceptions.py +│   └── openweathermap_wrapper.py +├── display (display drivers and functions) +│   ├── __init__.py +│   ├── display.py (this file acts like a wrapper for the display drivers) +│   ├── drivers (actual driver files are inside here) +│   │   ├── epd_7_in_5_colour.py (7.5" display driver). Each supported display has it's own driver +│   │   └── parallel_drivers (parallel display drivers, e.g. 9.7", 10.2" etc.) +│   ├── supported_models.py (this file contains the supported display models and is used to check which displays are supported) +│   └── test_display.py (a dummy driver which does not require a display to be attached) +├── fonts (fonts used by Inkycal are located here) +│   ├── NotoSansUI +│   ├── ProFont +│   └── WeatherFont +├── loggers.py (logging functions) +├── main.py (main file to run Inkycal) +├── modules (inkycal modules, e.g. calendar, weather, stocks etc.) +│   ├── __init__.py +│   ├── dev_module.py (a dummy module for development) +│   ├── ical_parser.py (parses icalendar files, not strictly a module, but helper class) +│   ├── inky_image.py (module to display images) +│   ├── inkycal_agenda.py (agenda module) +│   ├── inkycal_calendar.py (calendar module) +│   ├── inkycal_feeds.py (feeds module) +│   ├── inkycal_fullweather.py (full-weather module) +│   ├── inkycal_image.py (image module) +│   ├── inkycal_jokes.py (jokes module) +│   ├── inkycal_server.py (module for inkycal-server, by third party) +│   ├── inkycal_slideshow.py (slideshow module) +│   ├── inkycal_stocks.py (stocks module - credit to @worstface) +│   ├── inkycal_textfile_to_display.py (module to display text files) +│   ├── inkycal_tindie.py (tindie module) +│   ├── inkycal_todoist.py (todoist module) +│   ├── inkycal_weather.py (weather module) +│   ├── inkycal_webshot.py (webshot module - credit to @worstface) +│   ├── inkycal_xkcd.py (xkcd module - credit to @worstface) +│   └── template.py (template module) +├── settings.py (settings for Inkycal) +└── utils (utility functions) + ├── __init__.py + ├── json_cache.py + └── pisugar.py (PiSugar driver) +``` + ## Contributing All sorts of contributions are most welcome and appreciated. To start contributing, please follow -the [Contribution Guidelines](https://github.com/aceisace/Inkycal/blob/main/.github/CONTRIBUTING.md) +the [Contribution Guidelines](https://github.com/aceinnolab/Inkycal/blob/main/.github/CONTRIBUTING.md) The average response time for issues, PRs and emails is usually 24 hours. In some cases, it might be longer. If you want to have some faster responses, please use Discord (link below) @@ -286,7 +336,7 @@ We're happy to help, to beginners and developers alike. In fact, you are more li than on GitHub. - Inkycal chatroom Discord + Inkycal chatroom Discord ## Sponsoring @@ -325,5 +375,5 @@ perks after confirming 💯 ## Our Contributors -
aceisace
aceisace
Atrejoe
Atrejoe
actions-user
actions-user
emilyboda
emilyboda
StevenSeifried
StevenSeifried
mrbwburns
mrbwburns
dependabot[bot]
dependabot[bot]
LakesideMiners
LakesideMiners
hjiang
hjiang
ch3lmi
ch3lmi
mygrexit
mygrexit
tobychui
tobychui
worstface
worstface
sapostoluk
sapostoluk
freezingDaniel
freezingDaniel
dealyllama
dealyllama
rafaljanicki
rafaljanicki
priv-kweihmann
priv-kweihmann
surak
surak
AlessandroMandelli
AlessandroMandelli
DavidCamre
DavidCamre
jordanschau
jordanschau
mshulman
mshulman
vitasam
vitasam
+
aceinnolab
aceisace
Atrejoe
Atrejoe
actions-user
actions-user
emilyboda
emilyboda
StevenSeifried
StevenSeifried
mrbwburns
mrbwburns
dependabot[bot]
dependabot[bot]
LakesideMiners
LakesideMiners
hjiang
hjiang
ch3lmi
ch3lmi
mygrexit
mygrexit
tobychui
tobychui
worstface
worstface
sapostoluk
sapostoluk
freezingDaniel
freezingDaniel
dealyllama
dealyllama
rafaljanicki
rafaljanicki
priv-kweihmann
priv-kweihmann
surak
surak
AlessandroMandelli
AlessandroMandelli
DavidCamre
DavidCamre
jordanschau
jordanschau
mshulman
mshulman
vitasam
vitasam