diff --git a/README.md b/README.md index b18b20e..7526d70 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,36 @@ # ImHex-Patterns + Hex patterns, include patterns and magic files for the use with the ImHex Hex Editor + +
+ +## Table of Contents + +### Hex Patterns + +| Name | MIME | Path | Description | +|------|------|------|-------------| +| ELF | `application/x-executable` | `patterns/elf.hexpat` | ELF header in elf binaries | +| PE | `application/x-dosexec` | `patterns/pe.hexpat` | PE header, COFF header, Standard COFF fields and Windows Specific fields | +--- +
+ +### Include Patterns + +| Name | Path | Description | +|------|------|-------------| +| cstdint | `includes/cstdint.hexpat | C standard style fixed width integer types | +--- +
+ +### Magic files + +| Name | Path | Description | +|------|------|-------------| +| Nintendo Switch | `magic/nintendo_switch_magic` | Identifies common file types used on the Nintendo Switch | + +

+ +## Contributing + +If you want to contribute a file to the database, please make a PR which adds it to the right folder and adds a new entry to the table in this readme. Thanks a lot :) \ No newline at end of file