utils/MTP/beastpatcher/README

   1 beastpatcher - a tool for installing the Rockbox bootloader on the Gigabeat S
   2
   3 Unlike most other parts of the Rockbox project, this tool is
   4 distributed under the BSD license.  This is due to the fact that the
   5 Windows version links with the Microsoft MTP library.
   6
   7
   8
   9 Building instructions - All OSes
  10 --------------------------------
  11
  12 For all versions, you need to copy a "bootloader.bin" file (containing
  13 the Rockbox bootloader) into this directory.
  14
  15 This can be built from the Rockbox source by selecting "41" and then
  16 "B" when running tools/configure.
  17
  18 You need the Rockbox toolchain to build any Rockbox target binaries -
  19 this can be downloaded and built with the tools/rockboxdev.sh script.
  20
  21 The latest officially released bootloader can always be downloaded from:
  22
  23 http://download.rockbox.org/bootloader/toshiba/gigabeat-s/
  24
  25
  26
  27 Linux
  28 -----
  29
  30 The Unix versions requires libmtp, which in turn requires libusb.
  31
  32 beastpatcher is built to statically link to these libraries and
  33 expects them to exist as /usr/lib/libmtp.a and /usr/lib/libusb.a
  34 respectively.  Change the definition of LIBS in the Makefile if this
  35 is not the case for your system.
  36
  37 After this, just type "make" to get a
  38
  39
  40
  41 OS X
  42 ----
  43
  44 The OS X build is a universal binary statically linked with libusb and libmtp.
  45 It has been tested with libusb version 0.1.12 and libmtp version 1.0.1.
  46
  47 The following files are expected the beaspatcher source directory:
  48
  49 Intel:
  50     libusb: usb.h libusb-i386.a
  51     libmtp: libmtp.h libmtp-i386.a
  52
  53 PowerPC:
  54     libusb: usb.h libusb-ppc.a
  55     libmtp: libmtp.h libmtp-ppc.a
  56
  57 These are easily compiled from source using the standard
  58 './configure && make'. Look in .libs for libusb.a and src/.libs for libmtp.a,
  59 and make sure to rename them to their -i386/-ppc filenames when copying into
  60 the beastpatcher directory.
  61
  62 After this, just type "make beastpatcher-mac" to get a universal binary. If you
  63 only want a binary for a particular architecture, you can use
  64 "make beastpatcher-i386" or "make beastpatcher-ppc" instead. In this case, you
  65 only need the libusb and libmtp library for your desired architecture.
  66
  67
  68 Windows
  69 -------
  70
  71 The MTP_DLL.dll requires VC2005 to compile - see instructions in
  72 MTP_DLL/README
  73
  74 To compile beastpatcher itself, you can either cross-compile from
  75 Linux using the mingw32 package, or compile in Cygwin.  Just type
  76 "make beastpatcher.exe" (in Linux) or "make" (in Cygwin).
  77
  78 To run beastpatcher.exe, you need MTP_DLL.dll in the same directory
  79 (or the Windows DLL path).
  80
  81 Alternatively, beastpatcher can be built as binary that includes the
  82 MTP functionality and thus doesn't require the MTP_DLL. Building has
  83 the additional requirements as building the MTP_DLL. A VS2005 project
  84 file is available.
  85