Documentation

README.md

@@ -1 +1,8 @@
-# Omega - Keyboard app
+# 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`