Skip to content

Commit

Permalink
doc: update documentation (#116)
Browse files Browse the repository at this point in the history
  • Loading branch information
pythonbrad authored Oct 24, 2023
1 parent 3cafa5d commit 68ffb94
Show file tree
Hide file tree
Showing 5 changed files with 26 additions and 11 deletions.
25 changes: 14 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Afrim
Afrim ⌨️
===
[![Changelog](https://img.shields.io/badge/Keep%20a%20Changelog--555.svg?logo=data%3Aimage%2Fsvg%2Bxml%3Bbase64%2CPHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIGZpbGw9IiNmMTVkMzAiIHZpZXdCb3g9IjAgMCAxODcgMTg1Ij48cGF0aCBkPSJNNjIgN2MtMTUgMy0yOCAxMC0zNyAyMmExMjIgMTIyIDAgMDAtMTggOTEgNzQgNzQgMCAwMDE2IDM4YzYgOSAxNCAxNSAyNCAxOGE4OSA4OSAwIDAwMjQgNCA0NSA0NSAwIDAwNiAwbDMtMSAxMy0xYTE1OCAxNTggMCAwMDU1LTE3IDYzIDYzIDAgMDAzNS01MiAzNCAzNCAwIDAwLTEtNWMtMy0xOC05LTMzLTE5LTQ3LTEyLTE3LTI0LTI4LTM4LTM3QTg1IDg1IDAgMDA2MiA3em0zMCA4YzIwIDQgMzggMTQgNTMgMzEgMTcgMTggMjYgMzcgMjkgNTh2MTJjLTMgMTctMTMgMzAtMjggMzhhMTU1IDE1NSAwIDAxLTUzIDE2bC0xMyAyaC0xYTUxIDUxIDAgMDEtMTItMWwtMTctMmMtMTMtNC0yMy0xMi0yOS0yNy01LTEyLTgtMjQtOC0zOWExMzMgMTMzIDAgMDE4LTUwYzUtMTMgMTEtMjYgMjYtMzMgMTQtNyAyOS05IDQ1LTV6TTQwIDQ1YTk0IDk0IDAgMDAtMTcgNTQgNzUgNzUgMCAwMDYgMzJjOCAxOSAyMiAzMSA0MiAzMiAyMSAyIDQxLTIgNjAtMTRhNjAgNjAgMCAwMDIxLTE5IDUzIDUzIDAgMDA5LTI5YzAtMTYtOC0zMy0yMy01MWE0NyA0NyAwIDAwLTUtNWMtMjMtMjAtNDUtMjYtNjctMTgtMTIgNC0yMCA5LTI2IDE4em0xMDggNzZhNTAgNTAgMCAwMS0yMSAyMmMtMTcgOS0zMiAxMy00OCAxMy0xMSAwLTIxLTMtMzAtOS01LTMtOS05LTEzLTE2YTgxIDgxIDAgMDEtNi0zMiA5NCA5NCAwIDAxOC0zNSA5MCA5MCAwIDAxNi0xMmwxLTJjNS05IDEzLTEzIDIzLTE2IDE2LTUgMzItMyA1MCA5IDEzIDggMjMgMjAgMzAgMzYgNyAxNSA3IDI5IDAgNDJ6bS00My03M2MtMTctOC0zMy02LTQ2IDUtMTAgOC0xNiAyMC0xOSAzN2E1NCA1NCAwIDAwNSAzNGM3IDE1IDIwIDIzIDM3IDIyIDIyLTEgMzgtOSA0OC0yNGE0MSA0MSAwIDAwOC0yNCA0MyA0MyAwIDAwLTEtMTJjLTYtMTgtMTYtMzEtMzItMzh6bS0yMyA5MWgtMWMtNyAwLTE0LTItMjEtN2EyNyAyNyAwIDAxLTEwLTEzIDU3IDU3IDAgMDEtNC0yMCA2MyA2MyAwIDAxNi0yNWM1LTEyIDEyLTE5IDI0LTIxIDktMyAxOC0yIDI3IDIgMTQgNiAyMyAxOCAyNyAzM3MtMiAzMS0xNiA0MGMtMTEgOC0yMSAxMS0zMiAxMXptMS0zNHYxNGgtOFY2OGg4djI4bDEwLTEwaDExbC0xNCAxNSAxNyAxOEg5NnoiLz48L3N2Zz4K)](https://github.com/pythonbrad/afrim/blob/main/CHANGELOG.md)
[![crates.io](https://img.shields.io/crates/v/afrim.svg)](https://crates.io/crates/afrim)
Expand All @@ -16,10 +16,13 @@ License
Features
===

- [ ] Support for multiple African languages
- [ ] Easy to use interface
- [ ] Customizable dictionary
- [ ] Support for both desktop and web platform.
- [ ] 🌐 Support for all sequential codification codes.
- [ ] 🎨 Easy to use interface .
- [ ] 📚 Customizable dictionary.
- [ ] 💻 Support for both desktop and web platform.
- [ ] 🤖 Support for the Rhai scripting language.
- [ ] 📝 Auto-suggestion / Auto-correction / Auto-completion.
- [ ] ☁️ Full immersion mode for non-latin languages. (🚧 Experimental 🚧)

Installation
===
Expand Down Expand Up @@ -47,21 +50,21 @@ Try it in the console

Eg. `afrim configfile.toml`

Dataset
📚 Dataset
===
Official:
🏢 Official:
- [Afrim Supported Code](https://github.com/pythonbrad/afrim-data).

Community:
🧑🏿‍🤝‍🧑🏿 Community:
- Feel free to propose your own.

Frontends
🎨 Frontends
===

Official:
🏢 Official:
- [afrim-wish](https://github.com/pythonbrad/afrim-wish): Frontend for desktop environment.

Community:
🧑🏿‍🤝‍🧑🏿 Community:
- Feel free to propose your own.

Contributing
Expand Down
3 changes: 3 additions & 0 deletions config/README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,5 @@
# Afrim Config Manager
Manage the configuration of the afrim input method.

### Features
- rhai: Enable the usage of rhai scripts.
3 changes: 3 additions & 0 deletions engine/preprocessor/README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,5 @@
# Afrim Preprocessor
It generate a sequence of command to be perform to execute a particular task.

### Features
- inhibit: Enable the inhibit mode.
4 changes: 4 additions & 0 deletions engine/translator/README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,6 @@
# Afrim Translator
Handle the predication system for an input method.

### Features
- rhai: Enable the usage of the rhai scripting language.
- strsim: Enable the text similarity algorithm.
2 changes: 2 additions & 0 deletions memory/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# Afrime
Manage the memory for an input method.

0 comments on commit 68ffb94

Please sign in to comment.