From 06d32c55b3df855d6b5c82b12fbe0b04a2054ab5 Mon Sep 17 00:00:00 2001 From: "N0\\A" Date: Fri, 24 Oct 2025 12:07:02 +0200 Subject: [PATCH] Add usage instructions to README.md Added instructions for cloning and running the project. --- README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/README.md b/README.md index 79f44d1..d6003ae 100644 --- a/README.md +++ b/README.md @@ -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