Skip to content

Commit 0a62a58

Browse files
imersiaclaude
andcommitted
docs: Add all three install methods to README
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
1 parent 731daaa commit 0a62a58

1 file changed

Lines changed: 43 additions & 1 deletion

File tree

README.md

Lines changed: 43 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,17 +30,59 @@ A cute running cat CPU indicator for the [COSMIC desktop environment](https://sy
3030
flatpak install flathub io.github.reality2_roycdavies.cosmic-runkat
3131
```
3232

33-
Then add the applet to your panel:
33+
### From Source (Flatpak)
34+
35+
Requires `flatpak-builder` and the Freedesktop SDK with Rust extension.
36+
37+
```bash
38+
# Install the SDK and Rust extension (if not already installed)
39+
flatpak install flathub org.freedesktop.Platform//25.08 org.freedesktop.Sdk//25.08
40+
flatpak install flathub org.freedesktop.Sdk.Extension.rust-stable//25.08
41+
42+
# Clone and build
43+
git clone https://github.com/reality2-roycdavies/cosmic-runkat.git
44+
cd cosmic-runkat
45+
flatpak-builder --user --install --force-clean build-dir flathub/io.github.reality2_roycdavies.cosmic-runkat.yml
46+
```
47+
48+
### From Source (Native)
49+
50+
Requires Rust toolchain (1.75+) and COSMIC desktop libraries.
51+
52+
```bash
53+
git clone https://github.com/reality2-roycdavies/cosmic-runkat.git
54+
cd cosmic-runkat
55+
cargo build --release
56+
57+
install -Dm755 target/release/cosmic-runkat ~/.local/bin/cosmic-runkat
58+
install -Dm644 resources/io.github.reality2_roycdavies.cosmic-runkat.desktop ~/.local/share/applications/io.github.reality2_roycdavies.cosmic-runkat.desktop
59+
install -Dm644 resources/io.github.reality2_roycdavies.cosmic-runkat.svg ~/.local/share/icons/hicolor/scalable/apps/io.github.reality2_roycdavies.cosmic-runkat.svg
60+
install -Dm644 resources/io.github.reality2_roycdavies.cosmic-runkat-symbolic.svg ~/.local/share/icons/hicolor/symbolic/apps/io.github.reality2_roycdavies.cosmic-runkat-symbolic.svg
61+
```
62+
63+
### Adding to the Panel
64+
65+
After installing, add the applet to your COSMIC panel:
3466
1. Right-click the COSMIC panel → **Panel Settings**
3567
2. Click **+ Add Applet**
3668
3. Find **RunKat** and add it
3769

3870
### Uninstalling
3971

72+
**Flatpak:**
4073
```bash
4174
flatpak uninstall io.github.reality2_roycdavies.cosmic-runkat
4275
```
4376

77+
**Native:**
78+
```bash
79+
rm ~/.local/bin/cosmic-runkat
80+
rm ~/.local/share/applications/io.github.reality2_roycdavies.cosmic-runkat.desktop
81+
rm ~/.local/share/icons/hicolor/scalable/apps/io.github.reality2_roycdavies.cosmic-runkat.svg
82+
rm ~/.local/share/icons/hicolor/symbolic/apps/io.github.reality2_roycdavies.cosmic-runkat-symbolic.svg
83+
rm -rf ~/.config/cosmic-runkat
84+
```
85+
4486
## Usage
4587

4688
The applet runs as part of the COSMIC panel. Click it to open a popup showing per-core CPU stats.

0 commit comments

Comments
 (0)