diff --git a/README.md b/README.md index 8593fa4..9899a4d 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,37 @@ # firealpaca-flatpak -Simple script and config file to install FireAlpaca as a flatpak on any distro. (This repo doesn't contain any FireAlpaca source code.) \ No newline at end of file +Simple script and config file to install FireAlpaca as a flatpak on any distro. (This repo doesn't contain any FireAlpaca source code.) + +## Reason to use + +FireAlpaca has an AppImage, but it's only compatible with Glibc-based distros and it can be jank to manage it. If you want a more portable format or can't use the AppImage due to being on Alpine, Chimera, or another Musl distro, this script will extract the appimage and install it portably as a Flatpak for you. + +## Requirements + +* flatpak & flatpak-builder +* wget +* fuse and its libraries + +## How to use + +Sudo/doas perms are not required to run this script. It will build the Flatpak rootless. + +* ``git clone codeberg.org/gigirassy/firealpaca-flatpak --depth 1`` +* ``chmod +x install.sh`` +* ``./install.sh`` + +After, make a desktop entry with these contents if you'd like: + +``` +[Desktop Entry] +Type=Application +Name=FireAlpaca +Comment=FireAlpaca +Exec=/usr/bin/flatpak run com.firealpaca.FireAlpaca +Icon=/home/nune/.local/apps/firealpaca/icons/firealpaca +Terminal=false +Categories=Graphics; +X-AppImage-Version=2.14.0 +``` + +Then update your database: ``sudo update-desktop-database # or doas`` \ No newline at end of file