From c5b050e39906cbdd5c22616d0014414c6b6ff19e Mon Sep 17 00:00:00 2001 From: tlatorre Date: Sat, 12 Nov 2022 13:58:35 -0800 Subject: add README --- README | 40 ++++++++++++++++++++++++++++++++++++++++ 1 file changed, 40 insertions(+) create mode 100644 README (limited to 'README') diff --git a/README b/README new file mode 100644 index 0000000..2e68e24 --- /dev/null +++ b/README @@ -0,0 +1,40 @@ +Moji +==== + +Moji is a C program to help communicate with someone who only has the ability +to click a mouse button. It creates a simple full screen window that allows you +to cycle through emoji or an alphabet by clicking the left mouse button. It is +intended to be used with a special USB mouse that allows the person to click +the mouse with little effort (like +[this](https://www.amazon.com/dp/B071NT761Z?psc=1&ref=ppx_yo2ov_dt_b_product_details)). + +You can press the spacebar to switch between emoji and an alphabet. + +Compiling +========= + +I've only tested it on Fedora 36 and Rocky Linux 9. To install, first install a +few packages: + +To compile just run: + +```console +$ make +$ ./moji +``` + +To enable the text reading component, you should also run: + +```console +$ dnf install gtts mpg123 +``` + +Documentation +============= + +Currently, this README file is the only documentation. + +That's All Folks! +================= + +-- Anthony LaTorre -- cgit