readme update
This commit is contained in:
11
README.md
11
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.
|
||||
|
||||

|
||||
|
||||
@@ -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
|
||||
Reference in New Issue
Block a user