An intelligent reading companion for language learning powered by FSRS and AI
Transform your reading into an immersive language learning journey
readiamond is a desktop application designed for language learners who want to improve their reading skills. It combines a clean Markdown reader with powerful vocabulary learning tools, using spaced repetition algorithms to help you efficiently master new words while reading.
- Smart File Management - Tree view for organizing your reading materials, similar to Obsidian or VS Code
- Beautiful Rendering - Clean Markdown rendering optimized for long reading sessions
- Night Mode - Eye-friendly dark theme for comfortable reading
- Smart Highlighting - Familiar words are automatically highlighted based on your learning history
- One-Click Translation - Select any word to instantly view definitions, pronunciations, and examples
- Multiple Sources - Integrated with Youdao, Cambridge, and DeepL dictionaries
- Context Preservation - Save words along with their original sentences for better memorization
- Editable Notes - Edit and organize word definitions with your own insights
- FSRS Algorithm - Scientific spaced repetition system for optimal memory retention
- Auto-Generation - Automatically create flashcards from your saved vocabulary
- Progress Tracking - Visual statistics to monitor your learning journey
- Smart Review - Review reminders based on your familiarity level
- Intelligent Explanations - AI-powered word and phrase explanations
- Context Analysis - Understand words in their specific context
- Example Sentences - Get relevant, real-world usage examples
- Personalization - Customize fonts, themes, and reading preferences
- Keyboard Shortcuts - Efficient workflow with customizable hotkeys
- Data Management - Easy import/export of your vocabulary and progress
- Privacy First - All data stored locally, no cloud sync required
| Platform | Download | Version |
|---|---|---|
| macOS (Apple Silicon) | Download | v0.0.1-beta.4 |
| Windows | Coming Soon | coming soon |
| Linux | Coming Soon | coming soon |
The app supports auto-update and will notify you when a new version is available.
Since readiamond is an open-source application without Apple's code signing certificate, macOS may block the app from running due to security restrictions.
📖 Detailed Installation Guides:
- English Installation Guide - Step-by-step instructions for macOS users
- 中文安装指南 - macOS 用户详细安装步骤
Quick Summary:
- Download the
.dmgfile from Releases - Allow apps from all sources in System Settings → Privacy & Security
- Remove quarantine attributes using Terminal commands
- Drag the app to Applications folder
- Right-click and select "Open" to launch
- Windows: Run the
.exeinstaller - Linux: Install the
.AppImageor.debpackage
- Import your first document - Click the folder icon to add Markdown files
- Start reading - Select a file from the sidebar to begin
- Lookup words - Simply select any word to see its definition
- Build your vocabulary - Click "Add" to save words to your personal database
- Review with flashcards - Use the review feature to reinforce your learning
Frontend
- React 18 + TypeScript
- Tailwind CSS v4
- Redux Toolkit
- React Resizable Panels
Desktop & Storage
- Electron + Vite
- IndexedDB (Dexie)
- Electron Store
- Electron Updater
Core Libraries
- ts-fsrs - FSRS spaced repetition algorithm
- unified + retext-english - Text processing
- react-icons - Icon library
- Unified alert component for consistent notifications
- Custom file path settings
- Custom fsrs param
- Enhanced keyboard shortcuts for flashcard review
- Multi-language support (Chinese, Spanish, French, etc.)
- Community features for sharing vocabulary lists
Contributions are welcome! Here's how you can help:
- Report Bugs - Open an issue with detailed description
- Suggest Features - Share your ideas for improvements
- Submit Pull Requests - Help fix bugs or add features
- Improve Documentation - Help make documentation better
This project is licensed under the MIT License - see the LICENSE file for details.
- Author: ryuTeakwoo
- Email: mrliuzeyou@outlook.com
- Website: www.ryuteakwoo.com
- Project Homepage: www.readiamond.ryuteakwoo.com
Made with ❤️ by ryuTeakwoo
If you find this project helpful, please give it a ⭐