rm-files Documentation

Welcome to rm-files’ documentation.

Contents

• rmfiles Quickstart
  • Install
  • Minimal example
  • Primitives and transforms
  • Paths and curves
  • Turtle ergonomics
  • Tool presets
  • Run the demo
• 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)
  • QA Dependency Policy (0006)
  • ADR 0007: Scene Tree Lab Explorer
  • 0008: Shared Temp Output Directory
• Regression Tests
  • Where to look
  • Running tests
  • Updating fixtures
  • Regenerating all fixtures
  • Test helpers
  • Adding a new regression test

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.