ulahcherubim / latex-yearly-planner

Digital planner for Supernote and ReMarkable // Support Ukraine 🇺🇦 https://savelife.in.ua/en

latex-yearly-planner

PDF planner designed for e-ink devices.

See discussions for available planners and their variations.

Documentation work in progress

I am planning to write more documentation on how to use it and build it on your own. Spoiler alert: it won't be easy. Anyhow, more info on this will come.

Quick Start Guide

Here are the steps to quickly get the project up and running.

• Note: if you are here just for the planners you can find pre-generated planners in 2022-2032 Planners Discussions.

For the tinkerers, read on.

The following was tested with POP_OS 22.04.1 LTS under Virtualbox version 6.1

Install Dependencies

1. Go Language
2. LaTex & PDFLaTeX
3. From the project directory, run the following command after updating 'PLANNER_YEAR' below. This should generate the PDF in the 'out' directory. PLANNER_YEAR=2022
PASSES=1
CFG="cfg/base.yaml,cfg/template_breadcrumb.yaml,cfg/sn_a5x.breadcrumb.default.yaml"
NAME="sn_a5x.breadcrumb.default"
./single.sh

Source

4. Check the "out" directory for the 'pdf' planner. To move it to your device , follow the manufacturer's instructions on how to load a PDF on your device.

If you encounter any problems related to '.sty' files you likely need to install some Latex related dependencies. Copying the error and search using your favorite search engine should get you on track to resolving the dependency issues. All the best!

Alternative install

Instead of installing the dependencies manually, this repository is defined as a Nix flake which specifies fixed versions of all the required dependencies.

1. Install Nix
2. Build a planner pdf using nix build
3. Or, if you want to develop the code, enter a shell with all the dependencies present using nix develop

Preview examples