-
-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
4ede616
commit 878a8af
Showing
1 changed file
with
55 additions
and
42 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,42 +1,55 @@ | ||
| # Clafrica | ||
|
|
||
| [](https://crates.io/crates/clafrica) | ||
| [](https://github.com/pythonbrad/clafrica/blob/main/LICENSE) | ||
|  | ||
| [](https://docs.rs/clafrica) | ||
| [](https://discord.gg/C6TDEgzDzY) | ||
| [](https://coveralls.io/github/pythonbrad/clafrica?branch=main) | ||
|
|
||
|
|
||
| Clafrica is an input method for African languages. It's designed to make it easier for people who speak African languages to type on their computers. | ||
|
|
||
| ## Features | ||
|
|
||
| - Support for multiple African languages | ||
| - Easy to use interface | ||
| - Customizable dictionary | ||
| - Support for both desktop and web platform. | ||
|
|
||
| ## Installation | ||
|
|
||
| To use the input method, follow these steps: | ||
|
|
||
| 1. Clone the repository to your local machine. | ||
| 2. Install the required dependencies. | ||
| 3. Run the application. | ||
|
|
||
| ## Usage | ||
|
|
||
| To use the input method, simply select the language you want to type in and start typing. The keyboard layout can be customized to suit your needs. | ||
|
|
||
| ## Contributing | ||
|
|
||
| If you would like to contribute to this project, please fork the repository and submit a pull request with your changes. | ||
|
|
||
| ## Credits | ||
|
|
||
| This input method was developed by Fomegne Brady with contributions from the open-source community. | ||
|
|
||
| ## License | ||
|
|
||
| This project is licensed under the [MIT](LICENSE) license. | ||
| Clafrica | ||
| === | ||
| [](https://crates.io/crates/clafrica) | ||
| [](https://github.com/pythonbrad/clafrica/blob/main/LICENSE) | ||
|  | ||
| [](https://docs.rs/clafrica) | ||
| [](https://discord.gg/C6TDEgzDzY) | ||
| [](https://coveralls.io/github/pythonbrad/clafrica?branch=main) | ||
|
|
||
|
|
||
| Clafrica (a.k.a clafrica-rs) is an input method for African languages. It's designed to make it easier for people who speak African languages to type on their computers. | ||
|
|
||
| License | ||
| --- | ||
| [MIT](LICENSE) license. | ||
|
|
||
| Features | ||
| === | ||
| - [ ] Support for multiple African languages | ||
| - [ ] Easy to use interface | ||
| - [ ] Customizable dictionary | ||
| - [ ] Support for both desktop and web platform. | ||
|
|
||
| Installation | ||
| === | ||
|
|
||
| Build dependencies (Linux only) | ||
| --- | ||
| - libxtst-dev | ||
| - libevdev-dev | ||
| - libxdo-dev | ||
|
|
||
| Runtime dependencies (Linux only) | ||
| --- | ||
| - libxtst-dev | ||
| - libevdev-dev | ||
| - libxdo-dev | ||
|
|
||
| In using cargo | ||
| --- | ||
| `cargo install clafrica` | ||
|
|
||
| Try it in the console | ||
| --- | ||
| `clafrica-wish` comes with a REPL application which can be used to test if his library is working. | ||
| To use the clafrica, simply provide the path of the datafile that suit your needs. | ||
| Eg. `clafrica-wish clafrica_codes.txt` | ||
|
|
||
| Similar works | ||
| === | ||
| - [clafrica](https://github.com/H-Theking/clafrica): Python version | ||
|
|
||
| Contributing | ||
| === | ||
| If you would like to contribute to this project, please fork the repository and submit a pull request with your changes. |