N0VA/CLARA
1
1
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

readme update

Browse Source
This commit is contained in:
N0\A
2025-10-30 09:22:28 +01:00
parent aa3741e357
commit 620f6db259
1 changed files with 6 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
README.md
View File

@@ -1,7 +1,7 @@
# CLARA # CLARA
### Computer Linguistically Advanced Reactive Assistant ### 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) ![CLARA](/assets/2ktan.png)
@@ -11,8 +11,8 @@ A ***very*** WIP desktop assistant for X11-based desktops.
- App launcher - App launcher
- File search - File search
- Web search - Web search
- Updater (git) - Updater
- Super key menu - Super key menu (Doesn't work properly on Windows)
- Local network file and text transfer (Dukto protocol) - Local network file and text transfer (Dukto protocol)
- Browser based file and text transfer (HTTP) - Browser based file and text transfer (HTTP)
- Discord Rich Presence integration - Discord Rich Presence integration
@@ -21,17 +21,18 @@ A ***very*** WIP desktop assistant for X11-based desktops.
## Requirements ## Requirements
- Python 3 - Python 3
- X11 Desktop - X11 Desktop
- `fd` - [`fd`](https://github.com/sharkdp/fd)
- `git` - `git`
## Instructions ## Instructions
1. Clone this repository 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. 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). 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: 4. Launch `main.py`. Available options:
- `--restart` Add a restart option to the right click menu - `--restart` Add a restart option to the right click menu
- `--no-quit` Hide the quit option - `--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 - `--no-update` Don't update automatically on startup
If you want to contribute in any way, PRs (and issues) welcome If you want to contribute in any way, PRs (and issues) welcome