Github Best Practices#
The community has several best practices for remarkable related github repositories. We would like to request that when you host a repository on github or elsewhere you follow them where applicable.
In order to make new repositories more discouverable, they should be added to the remarkable-tablet topic.
In order to make it clear what users are allowed to do with a project/application, a license needs to be added to the repository. See Licensing a repository for more information on picking a license, and adding it to your repository.
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.
There are various badges that the community uses to make it easier for users, at a glance, 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.
reMarkable 2 support#
This badge is used to indicate that the application supports the reMarkable 2 tablet.
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.
<name with the name of the package in toltec.
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.