aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorNamjae Jeon <linkinjeon@gmail.com>2020-01-19 20:48:01 +0900
committerNamjae Jeon <linkinjeon@gmail.com>2020-01-19 20:48:01 +0900
commit51e471a747630ddfe7830dc8cf74bdb6dc6a4bc9 (patch)
tree414ca4ce017d973526e26b93767206297c2d66a7 /README.md
parent0199df132735b7ca20de091462c7a04cfa1e44bb (diff)
downloadexfatprogs-51e471a747630ddfe7830dc8cf74bdb6dc6a4bc9.tar.gz
exfat-tools: update README
Signed-off-by: Namjae Jeon <linkinjeon@gmail.com>
Diffstat (limited to 'README.md')
-rw-r--r--README.md41
1 files changed, 40 insertions, 1 deletions
diff --git a/README.md b/README.md
index 9da0585..83d6171 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,40 @@
-# exfat-tools \ No newline at end of file
+
+## exfat-tools ?
+Exfat-tools is mkfs(format)/fsck(repair) implementation for exfat filesystem under GNU GPL version 2. This opensource project was created by Namjae Jeon as exfat is officially supported in Linux kernel.
+
+## Maintainers
+
+* Namjae Jeon <linkinjeon@gmail.com>
+* Hyunchul Lee <hyc.lee@gmail.com>
+
+## building exfat tools
+
+Install preprequisite packages:
+ For Ubuntu:
+ sudo apt-get install autoconf libtool pkg-config
+
+ For Fedora, RHEL:
+ sudo yum install autoconf automake libtool
+
+Build steps:
+ - cd into the exfat-tools directory
+ - ./autogen.sh
+ - ./configure
+ - make
+ - make install
+
+## USING exFAT TOOLS
+
+- mkfs.exfat:
+ Build a exfat filesystem on a device or partition(e.g. /dev/hda1, dev/sda1).
+
+Usage example:
+ 1. No option(default) : cluster size adjustment as per device size, quick format.
+ mkfs.exfat /dev/sda1
+ 2. To change cluster size(KB) user want
+ mkfs.exfat -c 128 /dev/sda1
+ 3. For full format(zero out)
+ mkfs.exfat -f /dev/sda1
+
+- fsck.exfat(Preparing):
+ Check the consistency of your exfat filesystem and optinally repair a corrupted device formatted by exfat.