PDF planner designed for e-ink devices. To get started quickly, read the configuration section below to pick a configuration. Then, use this github workflow. Put in the Year and the configuration you want to use. The workflow will generate the planner.
The configuration for the planner is built up from a set of YAML files. The configuration
is a comma-separated list of files that are merged together to form the final configuration,
where each file overrides the previous one. The configuration files are located in the cfg
folder.
For example, to build a planner for the Remarkable Paper Pro, you might use this configuration:
cfg/base.yaml,cfg/template_breadcrumb.yaml,cfg/rmpp.base.yaml,cfg/rmpp.breadcrumb.default.dailycal.yaml
In order, this configuration includes:
- The base configuration (
base.yml), the building block for all configurations. - The
template_breadcrumb.ymlconfiguration, which adds breadcrumbs to the planner. - The
rmpp.base.ymlconfiguration, which adds the base configuration for the Remarkable Paper Pro. - The
rmpp.breadcrumb.default.dailycal.ymlconfiguration, which adds the default daily calendar configuration for the Remarkable Paper Pro.
My personal configurations:
- Remarkable Paper Pro:
cfg/base.yaml,cfg/template_breadcrumb.yaml,cfg/rmpp.base.yaml,cfg/rmpp.breadcrumb.default.dailycal.yaml - Remarkable 2:
cfg/base.yaml,cfg/template_breadcrumb.yaml,cfg/rm2.base.yaml,cfg/rm2.breadcrumb.default.dailycal.yaml
-
- For macs, the easiest option (but largest) is to do
brew install --cask mactex
- For macs, the easiest option (but largest) is to do
-
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 -
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!
