⚠️ Please report an issue on GitHub or on our Discord support server if following the instructions don't work

• InkycalOS-Lite can be downloaded after sponsoring Inkycal via GitHub sponsors. Please choose the one-time option for InkycalOS-Lite
• Forward the sponsoring confirmation-mail to the mail provided after sponsoring. You'll get a mail saying your email is now registered
• Visit the InkycalOS-Lite download page to get your download link. Don't worry if you missed it, you can always download it later too
• When there is a new release, you will receive a mail from us and can download it too

• Download Raspberry Pi Imager and install it. At the time of writing this, version 2.0 is the latest version
• Insert the microSD card in your PC
• Follow this GIF to see how to flash InkycalOS-Lite with Raspberry Pi Imager
• Once you're done, Take out the microSD card from the adapter and put it back in your PC

• Since Raspberry Pi Imager does not have an option to set the username and network details, we have to manually set this up
• Visit the Inkycal Raspberry Pi config page and add your details, except the username and the hostname
• Click on generate and download both files
• Copy these files into the bootfs folder, this is the one that's visible after flashing the OS. If you don't see this folder, take out the microSD card and re-insert it in your PC. It will ask you to overwrite the existing files, click on yes to overwrite

• You can set-up Inkycal with a single, settings.json file, which controls the behaviour of Inkycal e.g. modules/widgets, update times etc.
• Generate this file from the settings.json generator. Make sure you add at least one module
• Copy your settings.json file to the bootfs system on the microSD card

• By default, Inkycal will look for the settings.json file in the bootfs folder. If everything did look great in the settings.json file, you should now see your personal dashboard on the display
• If you're unhappy about the current settings, simply generate a new settings.json file from the link above and overwrite the file in bootfs on the microSD card

• If you see your display flicker - don't panic, this is just the normal way that nearly every e-paper display refreshes the screen
• If you don't see anything, don't panic. It can stem from a variety of issues, the main ones being:
  • the wiring is not the way it should be. First, lay your display with the front side up. Ignoring the extension cable, insert the display directly to the flex-cable connector on the hat / driver board
  • the settings.json file has an issue. In this case, you can either generate a new settings.json or use SSH to debug the issue

• Using a SSH client, e.g. Termius, create a new host with the following details:
• hostname: inkycal.local
• username: inky
• password: <your_password>
• method: SSH

Once you're connected, check what's causing this issue:

cd Inkycal
source venv/bin/activate
python inky_run.py

You will then see the error, if any. Copy the full error message and paste it on our Discord support server or as a Github issue. We'll get back soon!