From 53b86e343d9f98ace17f95015ac74d43f1547199 Mon Sep 17 00:00:00 2001 From: Brady Fomegne Date: Thu, 5 Sep 2024 22:26:57 +0100 Subject: [PATCH] doc: Increase project scope (#251) - updated "afrim" meaning - removed "history" --- FAQ.md | 9 +++++++++ README.md | 17 +---------------- 2 files changed, 10 insertions(+), 16 deletions(-) diff --git a/FAQ.md b/FAQ.md index 3358ca6..7ba0633 100644 --- a/FAQ.md +++ b/FAQ.md @@ -10,6 +10,15 @@ Afrim is also a library/tool to implement IME. **Disclaimer**: Afrim is not a writing system. Instead, it uses existing writing systems to operate. +What means Afrim? +--- + +"afrim" who is the transliteration of the Amharic word "እፍሪም," meaning shameful. + +"Shameful" symbolizes embracing vulnerability and self-awareness, turning mistakes into opportunities for growth and transformation. + +**Note**: Whether you use "afrim" or "Afrim," it doesn't matter. + How Afrim works? --- diff --git a/README.md b/README.md index b3e5c61..1a7e0f6 100644 --- a/README.md +++ b/README.md @@ -8,12 +8,11 @@ Afrim ⌨️ [![dependency status](https://deps.rs/repo/github/pythonbrad/afrim/status.svg)](https://deps.rs/repo/github/pythonbrad/afrim) [![Coverage Status](https://coveralls.io/repos/github/pythonbrad/afrim/badge.svg?branch=main)](https://coveralls.io/github/pythonbrad/afrim?branch=main) - Afrim is an input method for African languages. It is designed to protect the native language of various local dialects of Africa and is a universal phonetic-based input method platform. + Afrim is an input method designed to protect the native language of various local dialects and is a universal phonetic-based input method platform. Table of Contents --- -* [History](#history) * [Features](#features) * [Installation](#installation) * [Datasets](#-dataset) @@ -22,20 +21,6 @@ Table of Contents * [License](#licence) * [Contributing](#contributing) -History ---- -AFRIM is the abbreviation of *AFRICA IME* or *Africa Input Method Engine*. - -From the beginning, AFRIM was written as a remake of [Clafrica IME](https://github.com/H-Theking/clafrica), and named *clafrica*. - -Then, we created an input method library with some improvements inspired from [RIME](https://github.com/rime). We renamed it to *Afrim Input Method Engine*. - -Later, it supports Amharic and Geez and other african phonetic input method, and we want support all african phonetic Input Method. - -Inspired from [librime](https://github.com/rime/librime), we want AFRIM aka *Afrim Input Method Engine* to be the top IME for african languages. - -For more details on the project name, confer the issue https://github.com/pythonbrad/afrim/issues/107. - Features ===