Add usage instructions to README.md

Added instructions for cloning and running the project.
This commit is contained in:
N0\A
2025-10-24 12:07:02 +02:00
committed by GitHub
parent f6513b4776
commit 06d32c55b3

View File

@@ -12,4 +12,12 @@ A ***very*** WIP desktop assistant for X11-based desktops.
- Updater (git)
- Super key menu
## 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. 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
If you want to contribute in any way, PRs (and issues) welcome