Ruslin

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

English by DeepL  |  简体中文

[](https://github.com/ruslin-note/ruslin-android/actions/workflows/build.yml) [](https://github.com/ruslin-note/ruslin-android/blob/main/LICENSE) [](https://github.com/ruslin-note/ruslin-android/releases) [](https://github.com/ruslin-note/ruslin-android/releases) [](https://fosstodon.org/@ruslin)

🚧 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)

Download

<img src="https://fdroid.gitlab.io/artwork/badge/get-it-on.png" alt="Get it on F-Droid" height="80"> <img src="https://play.google.com/intl/en_us/badges/static/images/badges/en_badge_web_generic.png" alt="Get it on Google Play" height="80" /> <img src=".github/get-it-on-github.png" alt="Get it on GitHub" height="80"> or nightly.

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.

Build

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

Requirements

• Rust 1.69.0
• Android Studio
• NDK 25.2.9519653

Build Instructions

1. You need to set the NDK environment variable.

Example:

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

2. Build the Rust library.

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

3. Build the apk.

./gradlew :app:assembleDebug

For more build details, refer to Github Actions.

Credits

• Joplin: AGPL-3.0
• ReadYou: GPL-3.0
• Seal: GPL-3.0

License

GNU GPL v3.0