@@ 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`