shihaam/ISODroid
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 3 Wiki Activity

update docs

Browse Source
This commit is contained in:
Shihaam Abdul Rahman
2026-03-10 14:57:42 +05:00
parent b0672ac404
commit 20914ff2f0
1 changed files with 13 additions and 37 deletions
Download Patch File Download Diff File Expand all files Collapse all files

50
docs/BUILDING.md
View File

@@ -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` - Filename `archlinux-2024.12.01-x86_64.iso` → matches `archlinux.svg`
- Matching is case-insensitive and searches for icon name within filename - 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 ```bash
cd app/src/main/assets/osicons/ cd app/src/main/assets/osicons/
# Example: Manjaro uses Arch Linux icon # Linux Mint ISOs often named "mint-*.iso"
ln -s archlinux.svg manjaro.svg ln -s linuxmint.svg mint.svg
# Example: Kubuntu uses Ubuntu icon # Windows ISOs might be "Win11.iso" or "Win.iso"
ln -s ubuntu.svg kubuntu.svg 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 ### 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) - New SVG icon in `osicons/` (if applicable)
- Brief description of what you added - 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 ## Project Structure
``` ```