diff --git a/README.md b/README.md index c8fbf82..9a8487b 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,13 @@ -## About +###Table of Contents +1. [About](#about) +2. [Getting Started](#getting-started) +3. [Description](#description) +4. [Package Contents](#package-contents) +5. [Issues](#issues) +6. [Screenshot](#screenshot) + + +### About mucc is a tool for processing data recovered by scalpel. It's features include: 1. Splitting PDF files into sub-files. @@ -7,9 +16,18 @@ It's features include:

-## How it Works +### Getting Started +* Download and extract the [JavaFX SDK](https://gluonhq.com/products/javafx/). +* Add the `/javafx-sdk-11/lib/`as a library to your project. +* Add `--module-path /javafx-sdk-11/lib --add-modules=javafx.controls,javafx.fxml` to VM options. +* Run + +
+
+ +### Descripton -#### Retrieving Sub-Files +##### Retrieving Sub-Files scalpel parses disk images for %PDF headers and %EOF footers. @@ -18,13 +36,13 @@ 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` +### Package Contents | Class | Description | |---------------|-------------| @@ -41,7 +59,7 @@ Here mucc calculates the md5 hash of each file and deletes the identical files.

-## Issues +### Issues - %PDF tags are not parsed correctly if cat output contains multiple tabs. - Nested duplicates are not be deleted on first pass. @@ -52,7 +70,7 @@ Here mucc calculates the md5 hash of each file and deletes the identical files.

-## Screenshot +### Screenshot ![UI](src/app/img/screen.png) diff --git a/src/app/Main.java b/src/app/Main.java index 74f04c7..2295627 100644 --- a/src/app/Main.java +++ b/src/app/Main.java @@ -4,10 +4,8 @@ import javafx.application.Application; import javafx.fxml.FXMLLoader; import javafx.scene.Parent; import javafx.scene.Scene; -import javafx.stage.DirectoryChooser; import javafx.stage.Stage; -import java.io.File; public class Main extends Application { diff --git a/src/app/img/icon.png b/src/app/img/icon.png new file mode 100644 index 0000000..741b778 Binary files /dev/null and b/src/app/img/icon.png differ diff --git a/src/app/img/mucc-logo.png b/src/app/img/mucc-logo.png deleted file mode 100644 index fd8ffd5..0000000 Binary files a/src/app/img/mucc-logo.png and /dev/null differ