From 620f6db25911a9fdbd71d2ea2aa01439bd4f8380 Mon Sep 17 00:00:00 2001 From: "N0\\A" Date: Thu, 30 Oct 2025 09:22:28 +0100 Subject: [PATCH] readme update --- README.md | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 68b083e..57cca15 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ # CLARA ### Computer Linguistically Advanced Reactive Assistant -A ***very*** WIP desktop assistant for X11-based desktops. +A WIP desktop assistant for Linux and Windows. ![CLARA](/assets/2ktan.png) @@ -11,8 +11,8 @@ A ***very*** WIP desktop assistant for X11-based desktops. - App launcher - File search - Web search -- Updater (git) -- Super key menu +- Updater +- Super key menu (Doesn't work properly on Windows) - Local network file and text transfer (Dukto protocol) - Browser based file and text transfer (HTTP) - Discord Rich Presence integration @@ -21,17 +21,18 @@ A ***very*** WIP desktop assistant for X11-based desktops. ## Requirements - Python 3 - X11 Desktop -- `fd` +- [`fd`](https://github.com/sharkdp/fd) - `git` ## Instructions 1. Clone this repository 2. Install all of the modules from `requirements.txt`, either with `pip install -r requirements.txt` or via your distribution's package manager. 3. You will also need to install the `fd` command-line tool for the file search feature to work. (e.g., `sudo apt install fd-find` on Debian/Ubuntu, `sudo pacman -S fd` on Arch Linux). +> For other Linux distros and Windows go [here](https://github.com/sharkdp/fd) 4. Launch `main.py`. Available options: - `--restart` Add a restart option to the right click menu - `--no-quit` Hide the quit option - - `--no-super` Disable the super key menu + - `--no-super`/`--no-start` Disable the super key menu (recommended on Windows) - `--no-update` Don't update automatically on startup If you want to contribute in any way, PRs (and issues) welcome \ No newline at end of file