Update cmake generation setup.

[lwext4.git] / readme.txt

diff --git a/readme.txt b/readme.txt
index f7fba065c9df9ef65b782d9ed6bbcc32e29712e7..7bf83d339b5e20d4765f6947047b74a02e090a84 100644 (file)
--- a/readme.txt
+++ b/readme.txt
@@ -3,10 +3,29 @@ About lwext4
 ============\r
 \r
 The main goal of the lwext4 project is to provide ext2/3/4 filesystem\r
-library for microcontrolers.\r
+library for microcontrolers with SD/MMC card support. Ext2/3/4, in my\r
+opinion is one of the best filesystem for SD/MMC.\r
 \r
 kostka.grzegorz@gmail.com\r
 \r
+Minimum memory requirements\r
+===========================\r
+\r
+.text        ~ 15KB\r
+.data + .bss ~ 8KB\r
+.stack       ~ 1KB-2KB (not tested yet)\r
+\r
+ext2/3/4 vs FAT32\r
+=================\r
+ext2/3/4 > FAT32\r
+ - fseek operation on big file in FAT32 is IO heavy\r
+ - ext2/3/4 HTREE directories operations are faster than FAT32  \r
+ - ext4 extents makes truncate/remove opertion really fast\r
+ - more at https://ext4.wiki.kernel.org/index.php/Ext4_Disk_Layout\r
+\r
+ext2/3/4 < FAT32\r
+ - FAT32 has smaller footprint\r
+\r
 Credits lwext4\r
 ==============\r
 \r
@@ -34,7 +53,7 @@ FEATURE_INCOMPAT (able to mount with unsupported feature):
  - DIR_PREALLOC:   no\r
  - IMAGIC_INODES:  no\r
  - HAS_JOURNAL:    no\r
- - EXT_ATTR:      no\r
+ - EXT_ATTR:       no\r
  - RESIZE_INODE:   no\r
  - DIR_INDEX:      yes\r
 \r
@@ -48,8 +67,8 @@ FEATURE_RO (able to mount in read only with unsupported feature):
  - EXTRA_ISIZE:   yes\r
 \r
 Supported filetypes:\r
- - FIFO:         no\r
- - CHARDEV:      no\r
+ - FIFO:      no\r
+ - CHARDEV:   no\r
  - DIRECTORY: yes\r
  - BLOCKDEV:  no\r
  - FILE:      yes\r
@@ -75,7 +94,7 @@ lwext4 project tree
 \r
 +toolchain     - specific toolchain cmake files\r
 \r
-+ext4.h               - lwext4 client library header\r
++ext4.h        - lwext4 client library header\r
 CMakeLists.txt - CMake config file\r
 ext_images.7z  - ext2/3/4 100MB images\r
 Makefile       - helper makefile to call cmake\r