Skip to content

Commit

Permalink
doc: Increase project scope (#251)
Browse files Browse the repository at this point in the history
- updated "afrim" meaning
- removed "history"
  • Loading branch information
pythonbrad authored Sep 5, 2024
1 parent c675c82 commit 53b86e3
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 16 deletions.
9 changes: 9 additions & 0 deletions FAQ.md
Original file line number Diff line number Diff line change
Expand Up @@ -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?
---

Expand Down
17 changes: 1 addition & 16 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand All @@ -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
===

Expand Down

0 comments on commit 53b86e3

Please sign in to comment.