update docs

This commit is contained in:
2026-03-10 14:43:33 +05:00
parent 8a594618ef
commit ef5f7b4b58
2 changed files with 381 additions and 44 deletions

View File

@@ -4,7 +4,41 @@ Android app for mounting ISO/IMG files as USB mass storage or CD-ROM devices on
## Screenshots
Screenshots are available in the [docs/screenshots/](docs/screenshots/) directory.
<table>
<tr>
<td align="center">
<img src="docs/screenshots/list_images_home.jpg" width="250px" alt="File Browser"/>
<br />
<b>File Browser with OS Icons</b>
</td>
<td align="center">
<img src="docs/screenshots/mounted_status_home.jpg" width="250px" alt="Mounted Status"/>
<br />
<b>Mounted Status</b>
</td>
</tr>
<tr>
<td align="center">
<img src="docs/screenshots/mount_options_dialogbox.jpg" width="250px" alt="Mount Options"/>
<br />
<b>Mount Options Dialog</b>
</td>
<td align="center">
<img src="docs/screenshots/create_img_digalogbox.jpg" width="250px" alt="Create IMG"/>
<br />
<b>Create IMG Dialog</b>
</td>
</tr>
<tr>
<td align="center">
<img src="docs/screenshots/list_listing_download.jpg" width="250px" alt="Download ISOs"/>
<br />
<b>Download OS ISOs</b>
</td>
<td align="center">
</td>
</tr>
</table>
## Features
@@ -12,7 +46,6 @@ Screenshots are available in the [docs/screenshots/](docs/screenshots/) director
- Create blank IMG files for writable USB drives
- Read-only or read-write mount options
- Persistent notification with quick unmount button
- Browse and select ISO/IMG files from device storage
- OS-specific icons for popular distributions (Linux, BSD, etc.)
- Download links to popular operating systems (Linux, BSD, Windows, Recovery tools)
- Rename and delete files
@@ -24,44 +57,19 @@ Screenshots are available in the [docs/screenshots/](docs/screenshots/) director
- USB gadget support (configfs or sysfs)
- Android 8.0+ (API 26)
## Download
- **F-Droid**: *Coming soon*
- **Gitea Releases**: [Download latest APK](https://git.sargit.com/sargit/ISODroid/releases)
## Installation
### Option 1: Install APK (Recommended)
1. Download the latest ISO Droid APK from releases
2. Install the APK
3. Grant root access when prompted
4. The app includes a bundled isodrive binary
5. Place your ISO/IMG files in `/sdcard/isodrive/` (or configure a different directory in settings)
### Option 2: Install with Magisk Module
1. Install the [isodrive Magisk module](https://github.com/nitanmarcel/isodrive-magisk/releases/latest)
2. Install the ISO Droid APK
1. Download the APK from the links above
2. Install the APK on your rooted Android device
3. Grant root access when prompted
4. Place your ISO/IMG files in `/sdcard/isodrive/` (or configure a different directory in settings)
## Building from Source
### Prerequisites
Before building the app, you need to obtain the `isodrive` binary:
1. The `isodrive` binary is compiled from [nitanmarcel/isodrive](https://github.com/nitanmarcel/isodrive)
2. Place the compiled binary at `app/src/main/assets/bin/isodrive` before building
3. The binary must be executable and compiled for the appropriate Android architecture
### Build Steps
```bash
# Clone the repository
git clone https://github.com/yourusername/ISODroid.git
cd ISODroid
# Ensure isodrive binary is present
ls -la app/src/main/assets/bin/isodrive
# Build the APK
./gradlew assembleRelease
```
> **Note**: The app includes a bundled `isodrive` binary. No additional setup required!
## Usage
@@ -79,20 +87,16 @@ ls -la app/src/main/assets/bin/isodrive
3. The app will create a blank IMG file that can be mounted as a writable USB drive
4. Format it on your PC after mounting (FAT32, exFAT, NTFS, etc.)
## Documentation
- **[Building & Technical Details](docs/BUILDING.md)** - How to build from source, architecture overview, and technical documentation
## Credits
- [isodrive](https://github.com/nitanmarcel/isodrive) by nitanmarcel - The CLI tool that powers ISO Droid
- [ISODriveUT](https://github.com/fredldotme/ISODriveUT) by fredldotme - Original inspiration for isodrive
- OS icons from [Simple Icons](https://simpleicons.org/)
## Technical Details
ISO Droid uses the `isodrive` binary to interface with the Linux USB gadget subsystem. The app:
- Bundles the isodrive binary in `app/src/main/assets/bin/`
- Extracts and executes it with root permissions at runtime
- Supports both configfs (modern) and sysfs (legacy) USB gadget modes
- Dynamically detects available OS icons for file display
## License
MIT
GNU General Public License v3.0 - See [LICENSE](LICENSE) file for details