From a8b0e3879850fce311a14c589ac5ecb8184c10db Mon Sep 17 00:00:00 2001 From: Jason Pruitt Date: Thu, 15 Jun 2017 02:05:37 -0700 Subject: [PATCH 1/2] Create README.md --- README.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/README.md b/README.md index c7ce072..2e23512 100755 --- a/README.md +++ b/README.md @@ -5,6 +5,13 @@ UBI Reader is a Python module and collection of scripts capable of extracting the contents of UBI and UBIFS images, along with analyzing these images to determine the parameter settings to recreate them using the mtd-utils tools. +## Testing Branch +The testing branch includes a tools/ directory, that with scripts to help when trying to extract data from broken images. These also serve as examples of how to use ubi_reader in custom scripts. + +An override system is also included, for manually setting certain parameters that may be reported wrong by the UBI/FS data. + +This branch will probably remain seperate, as it is meant to be customized to aid in extracting data from problematic images. You can install it with 'python setup.py develop' to make it easier to modify ubi_reader as needed. + ## Dependencies: Python 2.7 is required. From dc352c4e34a774038a6151ba8f4ead8473292ca6 Mon Sep 17 00:00:00 2001 From: Jason Pruitt Date: Wed, 11 Oct 2017 20:56:59 -0700 Subject: [PATCH 2/2] Removed reference to fakeroot as it does not create real device files. --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index c7ce072..3800321 100755 --- a/README.md +++ b/README.md @@ -45,9 +45,9 @@ Run program with -h or --help for explanation of options. The script accepts a file with UBI or UBIFS data in it, so should work with a NAND dump. It will search for the first occurance of UBI or UBIFS data and attempt to -extract the contents. If file includes special files, you will may need to run as -fakeroot and set the (-k, --keep-permissions) option, for it to create these files. -With out it, it'll skip them and show a warning that these files were not created. +extract the contents. If file includes special files, you will need to run as +root or sudo for it to create these files. With out it, it'll skip them and show a +warning that these files were not created. ## Extracting Images: ubireader_extract_images [options] path/to/file