From aac9898d5ac6d3d9ebef8db5a8bbe175e3e4a794 Mon Sep 17 00:00:00 2001 From: Thastertyn Date: Sun, 6 Apr 2025 23:33:11 +0200 Subject: [PATCH] Documentation --- README.md | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 1927e98..0d736e5 100644 --- a/README.md +++ b/README.md @@ -1 +1,8 @@ -# Omega - Keyboard app \ No newline at end of file +# Omega - Keyboard app + +This is an onscreen keyboard app that used a Multilayer Perceptron for predicting next most likely key to be pressed. + +## Running +You must have a model trained for this purposed ready. +You can either use the prepackaged one (`./model.onnx`) or train one yourself (see [model README](./model/README.md)). +Then simply install the dependencies as per [`pyproject.toml`](./pyproject.toml) and run `main.py` \ No newline at end of file