summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorgkostka <kostka.grzegorz@gmail.com>2015-12-09 21:59:40 +0100
committergkostka <kostka.grzegorz@gmail.com>2015-12-09 22:03:34 +0100
commitbdd89bc6a923f1e22880d2485133db79f3773ff0 (patch)
tree23b2ac2728f0f8def4c2b523c72d18e832ce8bd4 /README.md
parentf5be9f5ec391ee19a442c5db5f1ebb6660ce685d (diff)
Add install target & new fs_tools names & readme update
Diffstat (limited to 'README.md')
-rw-r--r--README.md60
1 files changed, 38 insertions, 22 deletions
diff --git a/README.md b/README.md
index 96c879c..fcebd45 100644
--- a/README.md
+++ b/README.md
@@ -123,15 +123,15 @@ Generate makefiles
make
```
-Compile
+Compile & install tools
------------
```bash
cd build_generic
make
+ sudo make install
```
-
-Generic demo application
+lwext4-generic demo application
=====
Simple lwext4 library presentation:
* load ext2/3/4 images
@@ -142,34 +142,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