Github Best Practices#

The community has several best practices for reMarkable related github repositories. These guidelines make it easier for users to discover software and contribute back to the community.

remarkable-tablet topic#

In order to make new repositories more discoverable, they should be added to the remarkable-tablet topic.

License#

In order to make it clear what users are allowed to do with a project/application, a license should be added to the repository. See Licensing a repository for more information on picking a license, and adding it to your repository.

Badges#

Badges make it easier for users to understand the state of the application(s) in a repository.

reMarkable 1 support#

This badge is used to indicate that the application supports the reMarkable 1 tablet.

rM1 supported 
[![rm1](https://img.shields.io/badge/rM1-supported-green)](https://remarkable.com/store/remarkable)

reMarkable 2 support#

This badge is used to indicate that the application supports the reMarkable 2 tablet.

rM2 supported 
[![rm2](https://img.shields.io/badge/rM2-supported-green)](https://remarkable.com/store/remarkable-2)

Toltec package name#

This badge is used to indicate what the package name is in toltec, so users know at a glance what to install.

rM2 supported

Replace <name> with the name of the package in toltec.

[![opkg](https://img.shields.io/badge/OPKG-<name>-blue)](https://toltec-dev.org/)

Community Discord#

This badge is used to help grow the community, by making sure they know how to access the community discord. This allows people to get quicker help when they have questions they need answered.

https://img.shields.io/discord/385916768696139794.svg?label=reMarkable&logo=discord&logoColor=ffffff&color=7389D8&labelColor=6A7EC2 
[![Discord](https://img.shields.io/discord/385916768696139794.svg?label=reMarkable&logo=discord&logoColor=ffffff&color=7389D8&labelColor=6A7EC2)](https://discord.gg/ATqQGfu)

Github Actions#

In order to reduce friction for users who want to use your application, it’s best to include automated builds using github actions. Our recommendation would be to use toltecmk to build a toltec package, and include it as a release artifact.

If you are writing your own action meant to assist with developing applications for the reMarkable tablet, please include the action and remarkable-tablet topics to your repository. Users can then easily find all the available github actions with with a simple search.