diff --git a/README.md b/README.md index 488c6ad..268606f 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -### About +## About mucc is a tool for processing data recovered by scalpel. It's features include: 1. Splitting PDF files into sub-files. @@ -7,24 +7,24 @@ It's features include:

-### How it Works +## How it Works -##### Retrieving Sub-Files +#### Retrieving Sub-Files -scalpel parses a disk image for %PDF headers +scalpel parses disk images for %PDF headers and %EOF footers. If max_filsize is set high, the generated files will often consist of several concatenated sub-files. Here mucc finds the nested %PDF and %EOF tags and returns the files with byte sized precision. -##### Deleting Duplicates +#### Deleting Duplicates Here mucc calculates the md5 hash of each file and deletes the identical files.

-### Contents of `src/app` +## Contents of `src/app` | Class | Description | |---------------|-------------| @@ -38,14 +38,19 @@ Here mucc calculates the md5 hash of each file and deletes the identical files. | Tools | Simple tools used by other classes.| | Write | Writes to /tmp. Used for data storage.| +
+
-### Issues and Features +## Issues and Features - Fix issues where nested duplicates would not be deleted on first pass. - Make code prettier. - Add scalpel integration. - Replace "__" with progress indicators for states. -### Screenshot +
+
+ +## Screenshot ![UI](src/app/img/screen.png)