FIX: ext4_extent.c failed to be compiled.

[lwext4.git] / readme.mediawiki

diff --git a/readme.mediawiki b/readme.mediawiki
index a2971c389532b57a96288f8d8ee23616cf9eafe6..b97c3d46f7977a87fb5148df5977919c32ad55b1 100644 (file)
--- a/readme.mediawiki
+++ b/readme.mediawiki
@@ -1,13 +1,18 @@
 ==About==
 
-The main goal of the lwext4 project is to provide ext2/3/4 filesystem
-library for microcontrolers with SD/MMC card support. 
+The main goal of the lwext4 project is to provide ext2/3/4 filesystem for microcontrollers. It may be an interesting alternative for traditional MCU filesystem libraries (mostly based on FAT32).
 
+Lwext4 may be used with SD/MMC card, USB flash drive or other block based memory device. However it is not good for flash memory–based storage devices.
+
+Code is also available on github:
+https://github.com/gkostka/lwext4
+
+Feel free to contact me:
 kostka.grzegorz@gmail.com
 
 ==Minimum memory requirements==
-* .text:  20KB - 30KB (dependent of feature set chosen)
-* .data:  8KB
+* .text:  20KB - 40KB (dependent of feature set chosen)
+* .data:  8KB         (minimum 8 x 1KB  block cache)
 * .stack: 2KB
 
 
@@ -47,7 +52,7 @@ Some features are based on FreeBSD and Linux implementations.
 *  dir_prealloc: no
 *  imagic_inodes: no
 *  has_journal: no
-*  ext_attr: no
+*  ext_attr: no (work in progress)
 *  resize_inode: no
 *  dir_index: yes
 ;Features read-only (mount in RO mode when NOT supported):
@@ -60,15 +65,15 @@ Some features are based on FreeBSD and Linux implementations.
 *  extra_isize: yes
 *  quota: no
 *  bigalloc: no
-*  metadata_csum: no
+*  metadata_csum: no (to be done ...)
 
 ==Supported filetypes:==
 * FIFO:      no
 * CHARDEV:   no
 * DIRECTORY: yes
 * BLOCKDEV:  no
-* FILE:      yes
-* SOFTLINK:  no
+* FILE:      yes (hardlinks supported)
+* SOFTLINK:  yes
 * SOCKET:    no
 
 ==Other==
@@ -136,18 +141,7 @@ Windows volumes:
 
 Linux block devices:
  cd build_generic
- generic --in /dev/your_block_device
-
-Usage:                                                          
- --i   - input file              (default = ext2)            
- --rws - single R/W size         (default = 1024 * 1024)     
- --rwc - R/W count               (default = 10)                     
- --cache  - 0 static, 1 dynamic  (default = 1)               
- --dirs   - directory test count (default = 0)               
- --clean  - clean up after test                              
- --bstat  - block device stats                               
- --sbstat - superblock stats                                 
- --wpart  - windows partition mode                           
+ generic -i /dev/your_block_device
 
 ==Build and run automatic tests==
 Build and run automatic tests
@@ -162,7 +156,7 @@ Run server app for predefined images:
  make server_ext3
  make server_ext4
 Run tests:
- make all_tests
+ make test
 
 ==Cross-Compile standalone library==
 Build bf518 library:
@@ -190,11 +184,3 @@ Build cortex-m4 library:
  cd build_cortex-m4
  make lwext4
 
-==Demos==
-* STM32F429-DISCO USB flash drive Demo
-* ChibiOS demo applications
- 
-Build STM32F429 Demo:
- make cortex-m4
- cd build_cortex-m4
- make all