Skip to content

Added mention of AppImage to Readme and WebPage. #163

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
5cript merged 1 commit into from
May 6, 2026
Merged

Added mention of AppImage to Readme and WebPage. #163

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,13 +38,25 @@ sudo pacman -R nui-sftp

### All Other Distributions

#### AppImage

An AppImage is provided for most distributions. Download it from the releases section and run it directly:
```bash
chmod +x nui-sftp-*.AppImage
./nui-sftp-*.AppImage
```

#### Flatpak

For other distributions a flatpak is provided. Currently not in the official flathub, but that will come eventually.
Download the flatpak from a release and install it like so:
```bash
# Make sure to pass the correct file name!
flatpak install nui-sftp-flatpak-x86_64_0.1.1.flatpak
```

> **Note:** Local shells do not work inside the flatpak due to sandbox restrictions. If you need the local shell feature, use the AppImage or the AUR package instead.

## Apple Computers

macOS is currently not supported. Maybe in the future if there is demand.
Expand Down
3 changes: 2 additions & 1 deletion webpage/frontend/source/frontend/sections/platforms.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ namespace NuiSftpPage::Sections
std::string const versionLine = "AUR today " + Utf8::cp(0x00B7) + " Flathub & NixOS soon";

std::string const description =
"Native AUR package and a Flatpak bundle from Releases today. "
"Native AUR package, an AppImage, and a Flatpak bundle from Releases today. "
"Flathub and nixpkgs are on the way.";

return div{class_ = "platform-card glass shine"}(
Expand All @@ -93,6 +93,7 @@ namespace NuiSftpPage::Sections
)),
p{style = "margin: 0; color: var(--ink-dim); font-size: 14px"}(description),
pkgRow("yay -S nui-sftp", "archlinux user repository"),
pkgRow("./nui-sftp-*.AppImage", "appimage"),
pkgRow("flatpak install ./nui-sftp-*.flatpak", "from releases"),
pkgRow("flathub: org.nuicpp.nui_sftp", "soon", true),
pkgRow("nixpkgs.nui-sftp", "soon", true),
Expand Down
Loading