eeems/remarkable-toolchain

Remarkable-toolchain Docker镜像文档

概述

Remarkable-toolchain是一个专为Remarkable系列电子纸设备（如Remarkable 1、Remarkable 2）设计的Docker镜像，封装了完整的交叉编译工具链及开发依赖。该镜像旨在为开发者提供一致、便捷的开发环境，无需手动配置复杂的交叉编译工具和库文件，即可快速开展Remarkable设备相关的软件开发工作。

核心功能与特性

• 完整交叉编译环境：集成针对ARM架构的GCC工具链、链接器、汇编器等编译工具，支持生成Remarkable设备可执行的二进制文件
• 预配置开发依赖：包含设备特定的头文件、库文件及SDK组件，无需手动下载和配置开发依赖
• 多版本设备支持：兼容Remarkable 1和Remarkable 2等不同型号设备的硬件架构与系统版本
• 跨平台兼容性：基于Docker容器化封装，可在Linux、macOS、Windows等支持Docker的系统运行，确保开发环境一致性
• 轻量级设计：优化镜像体积，保留核心开发工具，减少资源占用

使用场景与适用范围

• Remarkable应用开发：开发适用于Remarkable设备的第三方应用程序、工具或插件
• 固件定制与编译：构建自定义设备固件或修改官方固件源码
• 开源项目构建：编译GitHub等平台上的Remarkable相关开源项目（如应用、驱动、工具等）
• 学习与研究：学习Remarkable设备的软件开发流程、交叉编译技术及硬件接口调用

使用方法与配置说明

前提条件

• 系统已安装Docker Engine（20.10+版本推荐）
• 本地已准备Remarkable项目代码（如克隆的应用源码、固件项目等）

基本使用命令

通过以下命令启动容器并挂载本地项目目录（假设项目位于/path/to/your/project），执行编译操作：

bash
docker run --rm -v /path/to/your/project:/workspace eeems/remarkable-toolchain:latest make -C /workspace

命令参数说明：

• --rm：容器退出后自动删除，避免残留容器实例
• -v /path/to/your/project:/workspace：将本地项目目录挂载到容器内的/workspace工作目录
• eeems/remarkable-toolchain:latest：使用最新版本镜像（可指定具体版本标签，如v1.2.0）
• make -C /workspace：在容器内执行make命令编译项目（根据项目构建系统可替换为cmake、ninja等）

高级使用配置

持久化编译缓存

如需保留编译缓存以加速后续构建，可挂载额外目录存储缓存文件：

bash
docker run --rm \
  -v /path/to/your/project:/workspace \
  -v /path/to/local/cache:/ccache \
  eeems/remarkable-toolchain:latest \
  sh -c "export CCACHE_DIR=/ccache && make -C /workspace"

指定目标设备版本

针对不同型号设备（如Remarkable 2），可通过环境变量指定编译目标：

bash
docker run --rm \
  -e TARGET_DEVICE=remarkable2 \
  -v /path/to/your/project:/workspace \
  eeems/remarkable-toolchain:latest \
  make -C /workspace

镜像更新与维护

• 获取最新版本：定期拉取镜像更新以获取工具链升级和依赖更新

  bash
  docker pull eeems/remarkable-toolchain:latest
  

• 源码与维护：镜像源代码托管于https://github.com/Eeems/images/tree/main/images/remarkable-toolchain%EF%BC%8C%E7%94%B1Eeems%E7%BB%B4%E6%8A%A4%EF%BC%8C%E5%8F%AF%E9%80%9A%E8%BF%87%E4%BB%93%E5%BA%93%E6%8F%90%E4%BA%A4Issue%E6%88%96PR%E5%8F%8D%E9%A6%88%E9%97%AE%E9%A2%98