Skip to content

Commit 7a4f1cb

Browse files
authored
Update README.md
1 parent fe87564 commit 7a4f1cb

File tree

1 file changed

+32
-9
lines changed

1 file changed

+32
-9
lines changed

README.md

Lines changed: 32 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,49 @@
1-
# TEMPLATE-AppImage 🐧
1+
# Cartridges-AppImage 🐧
22

3-
[![GitHub Downloads](https://img.shields.io/github/downloads/pkgforge-dev/TEMPLATE-AppImage/total?logo=github&label=GitHub%20Downloads)](https://github.com/pkgforge-dev/TEMPLATE-AppImage/releases/latest)
4-
[![CI Build Status](https://github.com//pkgforge-dev/TEMPLATE-AppImage/actions/workflows/appimage.yml/badge.svg)](https://github.com/pkgforge-dev/TEMPLATE-AppImage/releases/latest)
3+
[![GitHub Downloads](https://img.shields.io/github/downloads/pkgforge-dev/Cartridges-AppImage/total?logo=github&label=GitHub%20Downloads)](https://github.com/pkgforge-dev/Cartridges-AppImage/releases/latest)
4+
[![CI Build Status](https://github.com//pkgforge-dev/Cartridges-AppImage/actions/workflows/appimage.yml/badge.svg)](https://github.com/pkgforge-dev/Cartridges-AppImage/releases/latest)
55

6-
* [Latest Stable Release](https://github.com/pkgforge-dev/TEMPLATE-AppImage/releases/latest)
6+
<p align="center">
7+
<img src="https://raw.githubusercontent.com/kra-mo/cartridges/refs/heads/main/data/icons/hicolor/scalable/apps/page.kramo.Cartridges.svg" width="128" />
8+
</p>
9+
10+
* [Latest Stable Release](https://github.com/pkgforge-dev/Cartridges-AppImage/releases/latest)
711

812
---
913

10-
AppImage made using [sharun](https://github.com/VHSgunzo/sharun), which makes it extremely easy to turn any binary into a portable package without using containers or similar tricks.
14+
AppImage made using [sharun](https://github.com/VHSgunzo/sharun), which makes it extremely easy to turn any binary into a portable package without using containers or similar tricks.
1115

1216
**This AppImage bundles everything and should work on any linux distro, even on musl based ones.**
1317

14-
This AppImage can work **without FUSE** at all thanks to the [uruntime](https://github.com/VHSgunzo/uruntime)
18+
It is possible that this appimage may fail to work with appimagelauncher, I recommend these alternatives instead:
1519

16-
More at: [AnyLinux-AppImages](https://pkgforge-dev.github.io/Anylinux-AppImages/)
20+
* [AM](https://github.com/ivan-hc/AM) `am -i cartridges` or `appman -i cartridges`
21+
22+
* [dbin](https://github.com/xplshn/dbin) `dbin install cartridges.appimage`
23+
24+
* [soar](https://github.com/pkgforge/soar) `soar install cartridges`
25+
26+
This appimage works without fuse2 as it can use fuse3 instead, it can also work without fuse at all thanks to the [uruntime](https://github.com/VHSgunzo/uruntime)
1727

1828
<details>
1929
<summary><b><i>raison d'être</i></b></summary>
20-
<img src="https://github.com/user-attachments/assets/d40067a6-37d2-4784-927c-2c7f7cc6104b" alt="Inspiration Image">
30+
<img src="https://github.com/user-attachments/assets/29576c50-b39c-46c3-8c16-a54999438646" alt="Inspiration Image">
2131
</a>
2232
</details>
2333

34+
More at: [AnyLinux-AppImages](https://pkgforge-dev.github.io/Anylinux-AppImages/)
35+
2436
---
2537

26-
# Fork this repository to quickly make an AppImage using the [Anylinux-AppImages](https://github.com/pkgforge-dev/Anylinux-AppImages) tools
38+
## Known quirk
39+
40+
- Search-provider integration works only on Gnome (same as upstream) & it depends on:
41+
- the desktop file being present (which AppImage managers like `soar` & `am` already take care of).
42+
Desktop file needs to be named `page.kramo.Cartridges.desktop` for it to work.
43+
The only exception is the detection for desktop file `cartridges-AM.desktop` in local directories, which is added as a support for `am` AppImage manager.
44+
- the `XDG_DATA_DIRS` variable having the `XDG_DATA_HOME` in path, which the AppImage will detect if not present + warn about & suggest the solution.
45+
- This operation won't be performed if search integration files already exist in `/usr/share/` or `/usr/local/share/`, as it's assumed that the packager and/or system-administrator already handled that integration to the system. Modifying `XDG_DATA_DIRS` in that case is not needed.
46+
- If you use the AppImage portable folders feature, you only need to use portable `appimage-filename.config` and `appimage-filename.cache` folder to make the search-provider functionality work.
47+
- Those are the files that need to be in host's `${XDG_DATA_HOME}` for search-provider functionality to work, which you can delete after the app uninstallation, along with other app dotfiles:
48+
- `${XDG_DATA_HOME}/gnome-shell/search-providers/page.kramo.Cartridges.SearchProvider.ini`
49+
- `${XDG_DATA_HOME}/dbus-1/services/page.kramo.Cartridges.SearchProvider.service`

0 commit comments

Comments
 (0)