diff --git a/README.md b/README.md index 7a03719..01dea1b 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,42 @@ -# FAT32-Parser -Python-based parser for analyzing FAT32 file systems +# FAT32 Filesystem Parser +This python script is a FAT32 filesystem parser that allows you to analyze and parse FAT32 filesystems. + +## Options +``` + -h, --help - Print out the help menu + -i, --image IMAGE - Enter the path to the file system raw image + -m, --mbr - Parse Master Boot Record (MBR) only + -p, --partition - Select the partition number (from 1 to 4) for which you would like to retrieve the boot sector information. + -v, --verbose - Print out a quick documentation of every parsed field +``` + +## Usage +#### Parsing Master Boot Record only: +```bash +$ python3 --image /path/to/image --mbr +``` +* Using verbose Mode: +```bash +$ python3 --image /path/to/image --mbr --verbose +``` + +#### Parsing the entire disk image: +```bash +$ python3 --image /path/to/image +``` + +* Using verbose mode: +```bash +$ python3 --image /path/to/image --verbose +``` + +#### Parsing the boot sector of a specific partition +```bash +$ python3 --image /path/to/image -p [1-4] +``` + +## Requirements +```bash +$ pip3 install -r requirements.txt +``` +