~martijnbraam/thumbdrives

db7f22cf58632165717fbc738383d70edb0158c1 — Martijn Braam 12 days ago f64b198
Add readme
1 files changed, 24 insertions(+), 0 deletions(-)

A README.md
A README.md => README.md +24 -0
@@ 0,0 1,24 @@
# Thumbdrives

Thumbdrives is an USB mass storage emulator for Linux handhelds. It uses the
USB gadget configurations in the kernel to present a virtual USB CD drive or
thumbdrive to the attached device. This makes it possible to install linux
from the phone on the target device.

CD emulation above cdrom sizes is not supported by the kernel and those .iso
files will be emulated as usb mass storage instead. Files ending in .img will
always be emulated as usb mass storage and will be writable.

## Installation

```shell-session
$ meson build
$ cd build
$ ninja
$ sudo ninja install
```

## Kernel requirements

The kernel needs `CONFIG_CONFIGFS_FS`, `CONFIG_USB_F_MASS_STORAGE`,
`CONFIG_USB_CONFIGFS` and `CONFIG_USB_CONFIGFS_MASS_STORAGE`