Skip to content

parsifal486/readiamond

Repository files navigation

readiamond logo

readiamond

An intelligent reading companion for language learning powered by FSRS and AI

Transform your reading into an immersive language learning journey

Version License Platform


Overview

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.

readiamond Main Interface

readiamond Main Interface


Features

Immersive Reading Experience

Reading Interface

  • 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

Instant Dictionary Lookup

Word Management

  • 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

Spaced Repetition Flashcards

Flashcard Review

  • 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

AI-Enhanced Learning

AI Features

  • Intelligent Explanations - AI-powered word and phrase explanations
  • Context Analysis - Understand words in their specific context
  • Example Sentences - Get relevant, real-world usage examples

Customizable Settings

Settings

  • 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

Download

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.


Quick Start

Installation

macOS

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:

Quick Summary:

  1. Download the .dmg file from Releases
  2. Allow apps from all sources in System Settings → Privacy & Security
  3. Remove quarantine attributes using Terminal commands
  4. Drag the app to Applications folder
  5. Right-click and select "Open" to launch

Windows & Linux

  • Windows: Run the .exe installer
  • Linux: Install the .AppImage or .deb package

First Steps

  1. Import your first document - Click the folder icon to add Markdown files
  2. Start reading - Select a file from the sidebar to begin
  3. Lookup words - Simply select any word to see its definition
  4. Build your vocabulary - Click "Add" to save words to your personal database
  5. Review with flashcards - Use the review feature to reinforce your learning

Tech Stack

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

Coming Features

  • 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

Contributing

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

License

This project is licensed under the MIT License - see the LICENSE file for details.


Contact


Made with ❤️ by ryuTeakwoo

If you find this project helpful, please give it a ⭐

About

An intelligent reading companion for language learning powered by FSRS and AI

Resources

Stars

Watchers

Forks

Packages

 
 
 

Contributors

Languages