Wrote proper readme

This commit is contained in:
WerWolv
2020-12-03 21:50:05 +01:00
parent f2d85fd506
commit ddd7cdc5be

View File

@@ -1,2 +1,36 @@
# ImHex-Patterns
Hex patterns, include patterns and magic files for the use with the ImHex Hex Editor
<br/>
## 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 |
---
<br/>
### Include Patterns
| Name | Path | Description |
|------|------|-------------|
| cstdint | `includes/cstdint.hexpat | C standard style fixed width integer types |
---
<br/>
### Magic files
| Name | Path | Description |
|------|------|-------------|
| Nintendo Switch | `magic/nintendo_switch_magic` | Identifies common file types used on the Nintendo Switch |
<br/><br/>
## 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 :)