From 20914ff2f0e2cab86424f31af80a3580966b786c Mon Sep 17 00:00:00 2001 From: Shihaam Abdul Rahman Date: Tue, 10 Mar 2026 14:57:42 +0500 Subject: [PATCH] update docs --- docs/BUILDING.md | 50 +++++++++++++----------------------------------- 1 file changed, 13 insertions(+), 37 deletions(-) diff --git a/docs/BUILDING.md b/docs/BUILDING.md index 4ef99cc..58bcfb4 100644 --- a/docs/BUILDING.md +++ b/docs/BUILDING.md @@ -68,20 +68,26 @@ OS icons are displayed in the file browser when ISO/IMG filenames match the icon - Filename `archlinux-2024.12.01-x86_64.iso` → matches `archlinux.svg` - Matching is case-insensitive and searches for icon name within filename -3. **Symlinks for aliases:** +3. **Symlinks for filename variations:** - Some distributions have multiple names. You can create symlinks: + Sometimes ISO files use shortened or alternate names. Create symlinks to match these variations: ```bash cd app/src/main/assets/osicons/ - # Example: Manjaro uses Arch Linux icon - ln -s archlinux.svg manjaro.svg + # Linux Mint ISOs often named "mint-*.iso" + ln -s linuxmint.svg mint.svg - # Example: Kubuntu uses Ubuntu icon - ln -s ubuntu.svg kubuntu.svg + # Windows ISOs might be "Win11.iso" or "Win.iso" + ln -s windows.svg win.svg + ln -s windows.svg win11.svg + + # FreeBSD might be shortened + ln -s freebsd.svg bsd.svg ``` -4. Submit a pull request with your new icon(s) + This ensures `mint-21.3-cinnamon.iso` matches even though the icon is `linuxmint.svg` + +4. Submit a pull request with your new icon(s) and any necessary symlinks ### Adding OS Download Links @@ -134,36 +140,6 @@ The Downloads screen shows curated links to operating system ISOs. - New SVG icon in `osicons/` (if applicable) - Brief description of what you added -### OS Icon Symlinks - -Some distributions share the same logo. Use symlinks instead of duplicating files: - -**Common symlinks:** - -```bash -cd app/src/main/assets/osicons/ - -# Arch-based distributions -ln -s archlinux.svg manjaro.svg -ln -s archlinux.svg endeavouros.svg - -# Ubuntu derivatives -ln -s ubuntu.svg kubuntu.svg -ln -s ubuntu.svg xubuntu.svg -ln -s ubuntu.svg lubuntu.svg - -# Debian-based -ln -s debian.svg kali.svg -ln -s debian.svg raspbian.svg -``` - -**Why symlinks:** -- Reduces APK size -- Ensures consistency when upstream icon changes -- Makes maintenance easier - -**Note:** Git tracks symlinks, so they work across all platforms when cloned. - ## Project Structure ```