rm-files Documentation

Welcome to rm-files’ documentation.

Contents

• Architectural Decisions
  • 0001: QA Split, CI, and Docs
  • 0002: GitHub Pages Docs Deployment
  • The .rmdoc notebook package format
  • CLI Introduction (0003-cli-intro)
  • Adopt rmscene For .rm Read/Write (0005-rmscene-dependency)

Overview

rm-files provides a small API for constructing ReMarkable .rm (lines v6) files using the upstream rmscene library.

Quickstart

make venv
source .venv/bin/activate
python gen.py

This generates triangle.rm using the high-level notebook API.