Permalink
Browse files

refactor(docs) Reformat README for readability, see #19

  • Loading branch information...
1 parent 3e39f82 commit 79c2f1777332a0c731b71badc70233a682bd1bb1 @franz-josef-kaiser franz-josef-kaiser committed Jan 10, 2016
Showing with 179 additions and 153 deletions.
  1. +3 −0 .gitignore
  2. +0 −153 README
  3. +176 −0 README.md
View
@@ -1,3 +1,6 @@
.cproject
.project
fs.ext2
+
+# IDE: PhpStorm
+.idea
View
@@ -1,153 +0,0 @@
-
-Fuse-ext2 is a EXT2/EXT3/EXT4 Filesystem support for FUSE.
-
-Dependencies
-------------
-
- Fuse-ext2 requires at least Fuse version 2.6.0 for linux, for max os latest
-version of osxfuse (2.7.5).
-
-- Linux:
- Fuse from http://fuse.sourceforge.net/
-
-- Mac OS:
- OSXFuse from https://osxfuse.github.io
-
-
-Build
------
-
-- Linux:
- Dependencies:
-
- # fuse
- $ apt-get install libfuse
-
- Build from source depends on:
- m4, autoconf, automake, libtool
- fuse-dev, e2fsprogs-dev
-
- $ apt-get install m4 autoconf automake libtool
- $ apt-get install libfuse-dev e2fslibs-dev
-
- $ ./autogen.sh
- $ ./configure
- $ make
- $ sudo make install
-
- You can use checkinstall or some other equivalent tool to generate install
- package for your distribution.
-
-- Mac OS:
- Dependecies:
-
- # osxfuse
- https://osxfuse.github.io
- no need to install with macfuse compatibility
-
- Build:
-
- Build from source depends on m4, autoconf, automake, libtool and e2fsprogs
-
- $ export PATH=/opt/gnu/bin:$PATH
-
- $ mkdir gnu
- $ cd gnu
-
- # m4
- $ curl -O http://ftp.gnu.org/gnu/m4/m4-1.4.17.tar.gz
- $ tar -zxvf m4-1.4.17.tar.gz
- $ cd m4-1.4.17
- $ ./configure --prefix=/opt/gnu
- $ make -j 16
- $ sudo make install
- $ cd ../
-
- # autoconf
- $ curl -O http://ftp.gnu.org/gnu/autoconf/autoconf-2.69.tar.gz
- $ tar -zxvf autoconf-2.69.tar.gz
- $ cd autoconf-2.69
- $ ./configure --prefix=/opt/gnu
- $ make
- $ sudo make install
- $ cd ../
-
- # automake
- $ curl -O http://ftp.gnu.org/gnu/automake/automake-1.15.tar.gz
- $ tar -zxvf automake-1.15.tar.gz
- $ cd automake-1.15
- $ ./configure --prefix=/opt/gnu
- $ make
- $ sudo make install
- $ cd ../
-
- # libtool
- $ curl -O http://ftpmirror.gnu.org/libtool/libtool-2.4.6.tar.gz
- $ tar -zxvf libtool-2.4.6.tar.gz
- $ cd libtool-2.4.6
- $ ./configure --prefix=/opt/gnu
- $ make
- $ sudo make install
- $ cd ../
-
- # e2fsprogs
- $ curl -O https://www.kernel.org/pub/linux/kernel/people/tytso/e2fsprogs/v1.42.12/e2fsprogs-1.42.12.tar.gz
- $ tar -zxvf e2fsprogs-1.42.12.tar.gz
- $ cd e2fsprogs-1.42.12
- $ ./configure --prefix=/opt/gnu
- $ make
- $ sudo make install
- $ sudo make install-libs
- $ cd ../
-
- # fuse-ext2
- $ export PATH=/opt/gnu/bin:$PATH
- $ ./autogen.sh
- $ CFLAGS="-idirafter/opt/gnu/include -idirafter/usr/local/include/osxfuse/" LDFLAGS="-L/opt/gnu/lib -L/usr/local/lib" ./configure
- $ make
- $ sudo make install
-
-Test
-----
-
- $ dd if=/dev/zero of=test/fs.ext2 bs=1024 count=102400
- $ mkfs.ext4 test/fs.ext2
- $ fuse-ext2 test/fs.ext2 /mnt/fs.ext2 -o debug,rw+
-
-Usage
------
-
-Usage: fuse-ext2 <device|image_file> <mount_point> [-o option[,...]]
-
-Options: ro, force, allow_others
- Please see details in the manual.
-
-Example: fuse-ext2 /dev/sda1 /mnt/sda1
-
-Bugs
-----
-
-multithread support is broken for now, so forcing fuse to work single thread.
-
-there are no known bugs for read-only mode, read only mode should be ok for every one.
-
-altough, write support is available please do not mount your filesystems with write
-support unless you do not have anything to loose.
-
-please send output the output of below command while reporting bugs.
-
-$ /usr/local/bin/fuse-ext2 -v /dev/path /mnt/point -o debug
-
-Labels
-------
-
-please do not use comma ',' in partition labels.
-
-wrong: e2label /dev/disk0s3 "linux,ext3"
-
-correct: e2label /dev/disk0s3 "linux-ext3"
-
-Contact
--------
-
-Alper Akcan <alper.akcan@gmail.com>
View
@@ -0,0 +1,176 @@
+# Fuse Ext2
+
+> Fuse-ext2 is a EXT2/EXT3/EXT4 Filesystem support for _FUSE_.
+
+## Dependencies
+
+Fuse-ext2 requires at least Fuse version 2.6.0 for Linux.
+For Mac OS X latest version of OSXFuse 2.7.5.
+
+1. Linux: [Fuse](http://fuse.sourceforge.net/)
+1. Mac OS: [OSXFuse](https://osxfuse.github.io)
+
+
+## Build
+
+### Linux:
+
+Dependencies:
+
+```shell
+# fuse
+$ apt-get install libfuse
+```
+
+Build from source depends on:
+
+* m4
+* autoconf
+* automake
+* libtool
+* fuse-dev
+* e2fsprogs-dev
+
+```shell
+$ apt-get install m4 autoconf automake libtool
+$ apt-get install libfuse-dev e2fslibs-dev
+
+$ ./autogen.sh
+$ ./configure
+$ make
+$ sudo make install
+```
+
+You can use `checkinstall` or some other equivalent tool to generate install
+package for your distribution.
+
+### Mac OS:
+
+Dependecies:
+
+[OSXfuse](https://osxfuse.github.io) io no need to install with MacFuse compatibility.
+
+The easiest way is using [Homebrew](http://brew.sh/):
+
+```shell
+brew install e2fsprogs m4 automake autoconf libtool
+CFLAGS="-idirafter/$(brew --prefix e2fsprogs)/include -idirafter/usr/local/include/osxfuse" LDFLAGS="-L$(brew --prefix e2fsprogs)/lib" ./configure
+make
+sudo make install
+```
+
+Build:
+
+Build **from source** depends on:
+
+* m4
+* autoconf
+* automake
+* libtool
+* e2fsprogs
+
+```shell
+export PATH=/opt/gnu/bin:$PATH
+
+mkdir gnu
+cd gnu
+
+# m4
+curl -O http://ftp.gnu.org/gnu/m4/m4-1.4.17.tar.gz
+tar -zxvf m4-1.4.17.tar.gz
+cd m4-1.4.17
+./configure --prefix=/opt/gnu
+make -j 16
+sudo make install
+cd ../
+
+# autoconf
+curl -O http://ftp.gnu.org/gnu/autoconf/autoconf-2.69.tar.gz
+tar -zxvf autoconf-2.69.tar.gz
+cd autoconf-2.69
+./configure --prefix=/opt/gnu
+make
+sudo make install
+cd ../
+
+# automake
+curl -O http://ftp.gnu.org/gnu/automake/automake-1.15.tar.gz
+tar -zxvf automake-1.15.tar.gz
+cd automake-1.15
+./configure --prefix=/opt/gnu
+make
+sudo make install
+cd ../
+
+# libtool
+curl -O http://ftpmirror.gnu.org/libtool/libtool-2.4.6.tar.gz
+tar -zxvf libtool-2.4.6.tar.gz
+cd libtool-2.4.6
+./configure --prefix=/opt/gnu
+make
+sudo make install
+cd ../
+
+# e2fsprogs
+curl -O https://www.kernel.org/pub/linux/kernel/people/tytso/e2fsprogs/v1.42.12/e2fsprogs-1.42.12.tar.gz
+tar -zxvf e2fsprogs-1.42.12.tar.gz
+cd e2fsprogs-1.42.12
+./configure --prefix=/opt/gnu
+make
+sudo make install
+sudo make install-libs
+cd ../
+
+# fuse-ext2
+export PATH=/opt/gnu/bin:$PATH
+./autogen.sh
+CFLAGS="-idirafter/opt/gnu/include -idirafter/usr/local/include/osxfuse/" LDFLAGS="-L/opt/gnu/lib -L/usr/local/lib" ./configure
+make
+sudo make install
+```
+
+# Test
+
+```shell
+dd if=/dev/zero of=test/fs.ext2 bs=1024 count=102400
+mkfs.ext4 test/fs.ext2
+fuse-ext2 test/fs.ext2 /mnt/fs.ext2 -o debug,rw+
+```
+
+# Usage
+
+See [Man page](http://man.cx/fuseext2(1)) for options.
+
+```
+Usage: fuse-ext2 <device|image_file> <mount_point> [-o option[,...]]
+
+Options: ro, force, allow_others
+ Please see details in the manual.
+
+Example: fuse-ext2 /dev/sda1 /mnt/sda1
+```
+
+# Bugs
+
+* Multithread support is broken for now, so forcing fuse to work single thread.
+* there are no known bugs for read-only mode, read only mode should be ok for every one.
+* although, write support is available please do not mount your filesystems with write support unless you do not have anything to loose.
+
+Please send output the output of below command while reporting bugs as [GitHub Issue](https://github.com/alperakcan/fuse-ext2/issues/new).
+Before submitting a bug report, please look at the [existing issues](https://github.com/alperakcan/fuse-ext2/issues?utf8=%E2%9C%93&q=is%3Aissue) first.
+
+```shell
+$ /usr/local/bin/fuse-ext2 -v /dev/path /mnt/point -o debug
+```
+
+# Important: Partition Labels
+
+Please **do not** use comma `,` in partition labels.
+
+**Wrong:** `e2label /dev/disk0s3 "linux,ext3"`
+
+**Correct:** `e2label /dev/disk0s3 "linux-ext3"`
+
+# Contact
+
+Alper Akcan <alper.akcan@gmail.com>

0 comments on commit 79c2f17

Please sign in to comment.