README.md

May 3, 2025 · View on GitHub

Ruslin

A simple notes application that supports syncing notes using a self-hosted Joplin server.

English by DeepL | 简体中文

🚧 Currently in Pre-alpha, not ready for use in production environments. Please be careful to back up. 🚧

Supported features:

✅ Support Markdown edit and preview
✅ Full-text search using jieba-rs (Chinese and English supported)
✅ Sync notes using a self-hosted Joplin server
✅ Manual and automatic synchronization
🚧 Possible compatibility with Joplin's sync format (End-to-end encryption is not supported)

Ruslin is a reproducible build of app, you don't need to worry about F-Droid and other store signature issues, see: Towards a reproducible F-Droid.

Please help to translate with the Weblate

The following instructions are based on a Linux development environment and an arm64 physical device for debugging.

Example:

export ANDROID_HOME=$HOME/Android/Sdk
export NDK_VERSION=27.1.12297006

You can learn about how Kotlin interoperates with Rust from uniffi-rs.

Run build.sh in the ruslin-data-uniffi directory.

cd ruslin-data-uniffi
./build.sh

./gradlew :app:assembleDebug

For more build details, refer to Github Actions.