diff --git a/.gitignore b/.gitignore index 567609b..f9f1ba0 100644 --- a/.gitignore +++ b/.gitignore @@ -1 +1,4 @@ build/ +.coverage +*.extracted/ +*.pyc diff --git a/API.md b/API.md index 27d5b78..ad39666 100644 --- a/API.md +++ b/API.md @@ -81,7 +81,7 @@ for module in binwalk.scan('firmware1.bin', 'firmware2.bin', signature=True, qui Note the above use of the `--quiet` option which prevents the binwalk module from printing its normal output to screen. -Each module object will also have an additional `extractor` attribute, which is an instance of the `binwalk.modules.extractor.Extractor` class. Of particular use is `binwalk.modules.extractor.Extrctor.output`, a dictionary containing information about carved/extracted data: +Each module object will also have an additional `extractor` attribute, which is an instance of the `binwalk.modules.extractor.Extractor` class. Of particular use is `binwalk.modules.extractor.Extractor.output`, a dictionary containing information about carved/extracted data: ```python for module in binwalk.scan('firmware1.bin', 'firmware2.bin', signature=True, quiet=True, extract=True): diff --git a/INSTALL.md b/INSTALL.md index 107d2aa..7c40d0a 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -31,6 +31,12 @@ Although all binwalk run-time dependencies are optional, the `python-lzma` modul $ sudo apt-get install python-lzma ``` +Binwalk uses the `nosetest` library for tests and `coverage` for test-coverage: + +```bash +$ sudo pip install nose coverage +``` + Binwalk uses the `pycrypto` library to decrypt some known encrypted firmware images: ```bash diff --git a/README.md b/README.md index 297d656..ae27d81 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,5 @@ +[](https://travis-ci.org/devttys0/binwalk) + Description ===========