From 116caeaa7463bbeb7de69a86c733850e11fdee3d Mon Sep 17 00:00:00 2001 From: WerWolv Date: Sun, 31 Oct 2021 17:15:14 +0100 Subject: [PATCH] git: Update readme a little --- README.md | 46 ++++++++++++++++++++++++++++------------------ 1 file changed, 28 insertions(+), 18 deletions(-) diff --git a/README.md b/README.md index 24ac395ac..77e489676 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,8 @@

'Build' workflow Status - Discord Server + Discord Server + Total Downloads

## Supporting @@ -17,6 +18,11 @@ If you like my work, please consider supporting me on GitHub Sponsors, Patreon o PayPal donate button

+## Screenshots + +![](https://user-images.githubusercontent.com/10835354/139592192-46ba0aef-3096-4ba6-96ca-8d65c7b6bf57.png) +![](https://user-images.githubusercontent.com/10835354/139592467-27031984-4381-4341-aa18-e827eadca701.png) + ## Features - Featureful hex view @@ -33,7 +39,7 @@ If you like my work, please consider supporting me on GitHub Sponsors, Patreon o - Goto from start, end and current cursor position - Custom C++-like pattern language for parsing highlighting a file's content - Automatic loading based on MIME type - - arrays, pointers, structs, unions, enums, bitfields, using declarations, little and big endian support, conditionals and much more! + - arrays, pointers, structs, unions, enums, bitfields, namespaces, little and big endian support, conditionals and much more! - Useful error messages, syntax highlighting and error marking - Data importing - Base64 files @@ -71,20 +77,27 @@ If you like my work, please consider supporting me on GitHub Sponsors, Patreon o - Entropy graph - Highest and average entropy - Encrypted / Compressed file detection +- Built-in Content Store + - Download all files found in the database directly from within ImHex +- Yara Rules support + - Quickly scan a file for vulnearabilities with official yara rules - Helpful tools - Itanium and MSVC demangler - ASCII table - Regex replacer - Mathematical expression evaluator (Calculator) - Hexadecimal Color picker + - Base converter + - UNIX Permissions calculator + - Anonfiles File upload tool + - Wikipedia term definition finder + - File utilities + - File splitter + - File combiner + - File shredderer - Built-in cheat sheet for pattern language and Math evaluator - Doesn't burn out your retinas when used in late-night sessions -## Screenshots - -![](https://i.imgur.com/xH7xJ4g.png) -![](https://i.imgur.com/fhVJYEa.png) - ## Pattern Language The custom C-like Pattern Language developed and used by ImHex is easy to read, understand and learn. A guide with all features of the language can be found [in the wiki](https://github.com/WerWolv/ImHex/wiki/Pattern-Language-Guide) or a simpler version in ImHex under `Help -> Pattern Language Cheat Sheet` @@ -107,16 +120,12 @@ Nightlies are available via GitHub Actions [here](https://github.com/WerWolv/ImH ## Compiling -You need a C++20 compatible compiler such as GCC 10.2.0 to compile ImHex. Moreover, the following dependencies are needed for compiling ImHex: +You need a C++20 compatible compiler such as GCC 10.2.0 to compile ImHex. -- GLFW3 -- libmagic, libgnurx, libtre, libintl, libiconv -- libmbedtls -- capstone -- Python3 -- freetype2 -- Brew (macOS only) -- Xcode (macOS only) +Many dependencies are bundled into the repository using submodules so make sure to clone it using the `--recurse-submodules` option. +All dependencies that aren't bundled, can be installed using the dependency installer scripts found in the `/dist` folder. + +For working examples ### Windows @@ -200,8 +209,9 @@ with the environment variables `XDG_CONFIG_HOME`, `XDG_CONFIG_DIRS`, ## Credits - Thanks a lot to ocornut for their amazing [Dear ImGui](https://github.com/ocornut/imgui) which is used for building the entire interface - - Thanks to orconut as well for their hex editor view used as base for this project. + - Thanks to ocornut as well for their hex editor view used as base for this project. - Thanks to BalazsJako for their incredible [ImGuiColorTextEdit](https://github.com/BalazsJako/ImGuiColorTextEdit) used for the pattern language syntax highlighting - - Thanks to AirGuanZ for their amazing [imgui-filebrowser](https://github.com/AirGuanZ/imgui-filebrowser) used for loading and saving files - Thanks to nlohmann for their [json](https://github.com/nlohmann/json) library used for project files - Thanks to aquynh for [capstone](https://github.com/aquynh/capstone) which is the base of the disassembly window +- Thanks to vitaut for their [libfmt](https://github.com/fmtlib/fmt) library which makes formatting and logging so much better +- Thanks to rxi for [microtar](https://github.com/rxi/microtar) used for extracting downloaded store assets \ No newline at end of file