M5Stack_MicroPython/MicroPython_BUILD/components/mkfatfs/README.md

mkfatfs

Tool to build and unpack FatFS images. Thanks to jkearins,

Usage

   mkfatfs -c <pack_dir>|-u <dest_dir>|-l|-i} [-d <0-5>] [-b <number>] [-s <number>] [--] [--version] [-h] <image_file>


Where: 

   -c <pack_dir>,  --create <pack_dir>
     (OR required)  create fatfs image from a directory
         -- OR --
   -u <dest_dir>,  --unpack <dest_dir>
     (OR required)  unpack fatfs image to a directory
         -- OR --
   -l,  --list
     (OR required)  list files in fatfs image
         -- OR --
   -i,  --visualize
     (OR required)  visualize fatfs image


   -d <0-5>,  --debug <0-5>
     Debug level. 0 means no debug output.

   -s <number>,  --size <number>
     fs image size, in bytes

   --,  --ignore_rest
     Ignores the rest of the labeled arguments following this flag.

   --version
     Displays version information and exits.

   -h,  --help
     Displays usage information and exits.

   <image_file>
     (required)  fatfs image file

Build

You need gcc (≥4.8) or clang(≥600.0.57), and make. On Windows, use MinGW.

Run:

$ make dist

License

MIT

To do

• Flag -u is not released yet
• Flag -l is not released yet
• Flag -i is not released yet
• Add more debug output and print FATFS debug output
• Error handling
• Determine the image size automatically when opening a file
• Code cleanup