Home

Nimf Wiki

Nimf is a lightweight, fast and extensible multilingual input method framework.

🚀 Quick Start

Automatic Installation (Recommended)

# Install latest version with one command
curl -fsSL https://raw.githubusercontent.com/hamonikr/nimf/master/install | sudo bash

# Or using wget
wget -qO- https://raw.githubusercontent.com/hamonikr/nimf/master/install | sudo -E bash -

Docker-based Build

# Build for specific distributions
./scripts/build-docker.sh ubuntu.2404
./scripts/build-docker.sh debian.bookworm

# Build for all platforms
./scripts/build-docker.sh --all

📚 Documentation Guide

🔧 Installation & Build

• Installation Guide - Installation methods by distribution
• Build Instructions - Unified build system usage

⚙️ Configuration & Usage

• Configuration - Nimf configuration and usage
• Troubleshooting - Problem solving guide

🎯 Special Environments

• ARM Platforms - ARM64/ARM32 support platforms (Raspberry Pi, Armbian, etc.)

📦 Key Features

• 🌍 Multilingual Input: Korean, Japanese, Chinese, 100+ languages (m17n) support
• 🖥️ Platform Support: GTK2/3/4, Qt5/6, Wayland, X11 full support
• ⚡ Lightweight & Fast: Minimal resource usage and fast startup
• 🔧 Modular Structure: Core package + optional multilingual extension (nimf-i18n)
• 📦 Unified Build: Support for all major distributions including ARM64
• 🚀 Automatic Installation: ibus conflict resolution and environment setup automation

🌐 Language Support

• 🇺🇸 English Documentation - This page
• 🇰🇷 한국어 문서 - Korean documentation

🆘 Need Help?

• GitHub Issues - Bug reports and feature requests
• HamoniKR Community - Community support
• Troubleshooting - Common problem solutions

🤝 Contributing

To contribute to the Nimf project:

1. Fork the repository
2. Create a feature branch (git checkout -b feature/amazing-feature)
3. Commit your changes (git commit -m 'Add amazing feature')
4. Push to the branch (git push origin feature/amazing-feature)
5. Open a Pull Request

---

📋 License: LGPL-3.0