Update README.

master
Ivan Olexyn 6 years ago
parent eeea54fd8c
commit cb6e92daa8

@ -1,4 +1,4 @@
### About ## About
mucc is a tool for processing data recovered by scalpel. mucc is a tool for processing data recovered by scalpel.
It's features include: It's features include:
1. Splitting PDF files into sub-files. 1. Splitting PDF files into sub-files.
@ -7,24 +7,24 @@ It's features include:
<br> <br>
<br> <br>
### 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. and %EOF footers.
If max_filsize is set high, the generated files will often consist of several If max_filsize is set high, the generated files will often consist of several
concatenated sub-files. concatenated sub-files.
Here mucc finds the nested %PDF and %EOF tags Here mucc finds the nested %PDF and %EOF tags
and returns the files with byte sized precision. 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. Here mucc calculates the md5 hash of each file and deletes the identical files.
<br> <br>
<br> <br>
### Contents of `src/app` ## Contents of `src/app`
| Class | Description | | 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.| | Tools | Simple tools used by other classes.|
| Write | Writes to /tmp. Used for data storage.| | Write | Writes to /tmp. Used for data storage.|
<br>
<br>
### Issues and Features ## Issues and Features
- Fix issues where nested duplicates would not be deleted on first pass. - Fix issues where nested duplicates would not be deleted on first pass.
- Make code prettier. - Make code prettier.
- Add scalpel integration. - Add scalpel integration.
- Replace "__" with progress indicators for states. - Replace "__" with progress indicators for states.
### Screenshot <br>
<br>
## Screenshot
![UI](src/app/img/screen.png) ![UI](src/app/img/screen.png)

Loading…
Cancel
Save