ext4_extent: fix passing wrong size to memmove.

[lwext4.git] / README.md

diff --git a/README.md b/README.md
index 96c879c9ad3e7b1687ea5da398e12e34f1f9d915..b1cbb7fb2f5028c628e75ac7ea0652a64a60314a 100644 (file)
--- a/README.md
+++ b/README.md
@@ -107,33 +107,36 @@ Project tree
   
 Compile
 =====
-Windows
+Dependencies
 ------------
-* CMake:  http://www.cmake.org/cmake/resources/software.html
-* MinGw:  http://www.mingw.org/
-* GnuWin: http://gnuwin32.sourceforge.net/ 
+* Windows 
 
-Linux
-------------
-* CMake, make, gcc
+Download MSYS-2:  https://sourceforge.net/projects/msys2/
 
-Generate makefiles
-------------
+Install required packages is MSYS2 Shell package manager:
 ```bash
- make
- ```
+ pacman -S make gcc cmake p7zip
+  ```
+  
+* Linux 
 
-Compile
+Package installation (Debian):
+```bash
+ apt-get install make gcc cmake p7zip
+  ```
+ 
+Compile & install tools
 ------------
 ```bash
+ make generic
  cd build_generic
  make
+ sudo make install
  ```
 
-
-Generic demo application
+lwext4-generic demo application
 =====
-Simple lwext4 library presentation:
+Simple lwext4 library test application:
 * load ext2/3/4 images
 * load linux block device with ext2/3/4 part
 * load windows volume with ext2/3/4 filesystem 
@@ -142,34 +145,50 @@ Simple lwext4 library presentation:
 
 How to use for images/blockdevices:
 ```bash
- cd build_generic
- lwext4_generic -i ext_images/ext2 
- lwext4_generic -i ext_images/ext3 
- lwext4_generic -i ext_images/ext4 
+ lwext4-generic -i ext_images/ext2 
+ lwext4-generic -i ext_images/ext3 
+ lwext4-generic -i ext_images/ext4 
  ```
+ 
+Show full option set:
+```bash
+ lwext4-generic --help
+   ```
 
+Run automatic tests
+=====
 
-Build and run automatic tests
+Execute tests for 100MB unpacked images:
+```bash
+ make test
+   ```
+Execute tests for autogenerated 1GB images (only on Linux targets) + fsck:
+```bash
+ make test_all
+   ```
+Using lwext4-mkfs tool
 =====
-Build automatic test tools:
+It is possible to create ext2/3/4 partition by internal library tool.
+
+Generate empty file (1GB):
 ```bash
- make
- cd build_generic
- make
-  ```
-Uncompress ext/2/3/4 images:
+ dd if=/dev/zero of=ext_image bs=1M count=1024
+   ```
+Create ext2 partition:
 ```bash
- make unpack_images
+ lwext4-mkfs -i ext_image -e 2
    ```
-Run server for one of the image file:
+Create ext3 partition:
 ```bash
- make server_ext2
- make server_ext3
- make server_ext4
-  ```
-Execute tests:
+ lwext4-mkfs -i ext_image -e 3
+   ```
+Create ext4 partition:
 ```bash
- make test
+ lwext4-mkfs -i ext_image -e 4
+   ```
+Show full option set:
+```bash
+ lwext4-mkfs --help
    ```
 
 Cross compile standalone library