OSDN Git Service

Make README.md more text-friendly.
[android-x86/external-exfat.git] / README.md
index cfcfa7a..d554f2a 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,6 +1,7 @@
-# About
+About
+-----
 
-This project aims to provide a full-featured [exFAT](http://en.wikipedia.org/wiki/ExFAT) file system implementation for Unix-like systems. It consists of a [FUSE](http://en.wikipedia.org/wiki/Filesystem_in_Userspace) module (fuse-exfat) and a set of utilities (exfat-utils).
+This project aims to provide a full-featured [exFAT][1] file system implementation for Unix-like systems. It consists of a [FUSE][2] module (fuse-exfat) and a set of utilities (exfat-utils).
 
 Supported operating systems:
 
@@ -11,7 +12,8 @@ Supported operating systems:
 
 Most GNU/Linux distributions already have fuse-exfat and exfat-utils in their repositories, so you can just install and use them. The next chapter describes how to compile them from source.
 
-# Compiling
+Compiling
+---------
 
 To build this project under GNU/Linux you need to install the following packages:
 
@@ -25,30 +27,30 @@ To build this project under GNU/Linux you need to install the following packages
 
 Get the source code, change directory and compile:
 
-```
-git clone https://github.com/relan/exfat.git
-cd exfat
-autoreconf --install
-./configure --prefix=/usr
-make
-```
+    git clone https://github.com/relan/exfat.git
+    cd exfat
+    autoreconf --install
+    ./configure --prefix=/usr
+    make
 
 Then install driver and utilities:
 
-```
-sudo make install
-```
+    sudo make install
 
-# Mounting
+Mounting
+--------
 
 Modern GNU/Linux distributions will mount exFAT volumes automatically—util-linux-ng 2.18 (was renamed to util-linux in 2.19) is required for this. Anyway, you can mount manually (you will need root privileges):
 
-```
-sudo mount.exfat-fuse /dev/sdXn /mnt/exfat
-```
+    sudo mount.exfat-fuse /dev/sdXn /mnt/exfat
 
 where /dev/sdXn is the partition special file, /mnt/exfat is a mountpoint.
 
-# Feedback
+Feedback
+--------
 
-If you have any questions, issues, suggestions, bug reports, etc. please create an [issue](https://github.com/relan/exfat/issues). Pull requests are also welcome!
+If you have any questions, issues, suggestions, bug reports, etc. please create an [issue][3]. Pull requests are also welcome!
+
+[1]: http://en.wikipedia.org/wiki/ExFAT
+[2]: http://en.wikipedia.org/wiki/Filesystem_in_Userspace
+[3]: https://github.com/relan/exfat/issues