Skip to content

Commit 1d70e3d

Browse files
committed
update readme instructions
1 parent 0d51389 commit 1d70e3d

1 file changed

Lines changed: 4 additions & 60 deletions

File tree

README.md

Lines changed: 4 additions & 60 deletions
Original file line numberDiff line numberDiff line change
@@ -137,45 +137,6 @@ groups
137137
# You should see 'input' in the list
138138
```
139139

140-
### Usage
141-
142-
143-
- Run the application:
144-
```bash
145-
./target/release/shortcuts-overlay
146-
```
147-
148-
The overlay will automatically appear when you press and hold the **Ctrl** key (left or right), and disappear when you release it. The application uses libinput for global keyboard monitoring.
149-
150-
- CLI options
151-
- `--width <PX>` — overlay client width in pixels (default: 1200)
152-
- `--height <PX>` — overlay client height in pixels (default: 800)
153-
- `--anchor <POSITION>` — overlay anchor position (default: center)
154-
- Available values: `center`, `topleft`, `topright`, `bottomleft`, `bottomright`, `top`, `bottom`, `left`, `right`
155-
156-
- Environment variables (alternative to CLI)
157-
- `SHORTCUTS_OVERLAY_WIDTH` — overlay client width in pixels
158-
- `SHORTCUTS_OVERLAY_HEIGHT` — overlay client height in pixels
159-
160-
### Installing Desktop Entry & Icon
161-
162-
To make the application appear in your application launcher with an icon:
163-
164-
```bash
165-
# Install desktop entry and icon
166-
make install-desktop
167-
168-
# This will:
169-
# - Install logo.svg to ~/.local/share/icons/hicolor/scalable/apps/shortcuts-overlay.svg
170-
# - Install shortcut-overlay.desktop to ~/.local/share/applications/
171-
# - Update icon and desktop databases
172-
```
173-
174-
To uninstall:
175-
```bash
176-
make uninstall-desktop
177-
```
178-
179140
### Building Distribution Packages
180141

181142
You can build Debian (.deb) or RPM packages for easier distribution and installation:
@@ -191,45 +152,28 @@ make package-rpm
191152
make package-all
192153
```
193154

194-
The packages will include:
195-
- Binary installed to `/usr/bin/shortcuts-overlay`
196-
- Desktop entry and icon
197-
- Default configuration template
198-
- Documentation
199-
200-
For detailed packaging instructions, see [PACKAGING.md](PACKAGING.md).
201-
202155
#### Installing Packages
203156

204157
**Debian/Ubuntu:**
205158
```bash
206159
sudo dpkg -i target/debian/shortcuts-overlay_*.deb
207-
sudo apt-get install -f # Install dependencies if needed
208160
```
209161

210162
**Fedora/RHEL:**
211163
```bash
212164
sudo dnf install target/generate-rpm/shortcuts-overlay-*.rpm
213165
```
214166

215-
**openSUSE:**
216-
```bash
217-
sudo zypper install target/generate-rpm/shortcuts-overlay-*.rpm
218-
```
219-
220-
- Examples:
167+
## Usage:
221168
```bash
222169
# Run with explicit size via CLI
223-
./target/release/shortcuts-overlay --width 1200 --height 800
170+
shortcuts-overlay --width 1200 --height 800
224171

225172
# Run with custom anchor position
226-
./target/release/shortcuts-overlay --anchor topright
173+
shortcuts-overlay --anchor topright
227174

228175
# Run with size and anchor
229-
./target/release/shortcuts-overlay --width 1200 --height 800 --anchor bottomleft
230-
231-
# Run with env vars
232-
SHORTCUTS_OVERLAY_WIDTH=900 SHORTCUTS_OVERLAY_HEIGHT=500 ./target/release/shortcuts-overlay
176+
shortcuts-overlay --width 1200 --height 800 --anchor bottomleft
233177
```
234178

235179
### How It Works

0 commit comments

Comments
 (0)