Skip to content
forked from toltec-dev/toltec

Community-maintained repository of free software for the reMarkable tablet.

License

Notifications You must be signed in to change notification settings

marie6324/toltec

 
 

Repository files navigation

Toltec

Status of the stable repository Status of the testing repository rM1: supported rM2: supported Discord

Toltec is a community-maintained repository of free software for the reMarkable tablet.

Pre-Installation WARNING

Toltec does not currently support beta OS builds on the reMarkable 2. You will likely soft-brick your device if you install before support is released. See remarkable2-recovery for information on how to recover your device if you have done this.

Install it

Toltec works on top of the Opkg package manager and the Entware distribution, which are in widespread use in embedded devices. To automatically install Opkg, Entware and Toltec, make sure your device is connected to Wi-Fi and run the bootstrap script in an SSH session:

wget http://toltec-dev.org/bootstrap
echo "2d1233271e0cc8232e86827bcb37ab2a44be2c5675cd15f32952614916ae246a  bootstrap" | sha256sum -c && bash bootstrap

Warning: Do not run bash bootstrap without the preceding SHA-256 check unless you know what you are doing. The check is necessary to prevent MITM attacks since the built-in wget binary does not implement TLS. The bootstrap script takes care of replacing it with wget-ssl.

What does this script do? This script will create a .entware folder in your home directory, containing a complete Entware distribution (fetched from https://bin.entware.net/armv7sf-k3.2/), and permanently mount it to /opt. It will then configure Opkg for use with Toltec and configure your system to automatically find binaries from /opt. You are encouraged to audit the script.

You now have access to all of the Toltec and Entware packages! To seamlessly switch between applications, you may want to start by installing a launcher.

Browse the list of available Toltec packages →

Browse the list of available Entware packages →

Use it

To install a package:

opkg install calculator

To remove a package:

opkg remove calculator

To update all packages:

opkg update
opkg upgrade

See information about advanced Opkg commands →

To re-enable Toltec after a system update:

toltecctl reenable

To remove Toltec and all its packages:

toltecctl uninstall

To switch to the testing branch:

toltecctl switch-branch testing
opkg upgrade

Choose a release branch: stable or testing

Build it

This Git repository contains all the tools and recipes required to build the packages published on the package repository. This repository is automatically built and published every time that a commit is pushed to Git, using Github Actions. Since all the packaged software in Toltec is free, you can also build them from source yourself instead of using the pre-built binaries. The build process is fully reproducible, which means that you can verify that the published packages have not been tampered with during the automated build process.

Learn how to build the repository from source →

Improve it

Your contribution is welcome for adding new packages, updating existing ones or improving the build tooling.

Learn how to contribute to Toltec →

About

Community-maintained repository of free software for the reMarkable tablet.

Resources

License

Code of conduct

Security policy

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Shell 54.7%
  • Python 41.4%
  • HTML 2.3%
  • Makefile 1.6%