Merge pull request #175 from mdhvg/docs/format-readme

Format README and separate all Linux Build and Run instructions.
This commit is contained in:
Hors 2023-10-08 19:53:42 +02:00 committed by GitHub
commit 38984ae43b
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 76 additions and 64 deletions

View file

@ -7,13 +7,9 @@
[![OS Windows](https://img.shields.io/badge/os-windows-brightgreen)](https://github.com/horsicq/DIE-engine/releases)
[![OS MacOS](https://img.shields.io/badge/os-macos-brightgreen)](https://github.com/horsicq/DIE-engine/releases)
Detect It Easy
==============
# Detect It Easy
* Download: https://github.com/horsicq/DIE-engine/releases
* How to run: https://github.com/horsicq/Detect-It-Easy/blob/master/docs/RUN.md
* How to build: https://github.com/horsicq/Detect-It-Easy/blob/master/docs/BUILD.md
* Changelog: https://github.com/horsicq/Detect-It-Easy/blob/master/changelog.txt
- Changelog: https://github.com/horsicq/Detect-It-Easy/blob/master/changelog.txt
You can help with translation: https://github.com/horsicq/XTranslation
@ -52,28 +48,61 @@ in the folder "db". If you open this folder, nested sub-folders will be found
First, DIE determines the type of file, and then sequentially loads all the signatures,
which lie in the corresponding folder. Currently the program defines the following types:
* MSDOS executable files MS-DOS
* PE executable files Windows
* ELF executable files Linux
* MACH executable files Mac OS
* Binary all other files
- MSDOS executable files MS-DOS
- PE executable files Windows
- ELF executable files Linux
- MACH executable files Mac OS
- Binary all other files
Packages
=======
# Downlods
- Chocolatey(Windows): https://community.chocolatey.org/packages/die (Thanks **chtof**(https://github.com/chtof) and **Rob Reynolds**(https://github.com/ferventcoder))
- Parrot OS: Package name **detect-it-easy** (Thanks **Nong Hoang Tu**(https://github.com/dmknght))
- Arch Linux: https://aur.archlinux.org/packages/detect-it-easy-git/ (Thanks **Arnaud Dovi**(https://github.com/class101))
- REMnux https://remnux.org/ (Thanks **REMnux team**(https://twitter.com/REMnux/status/1401935989266919426))
- openSUSE https://build.opensuse.org/package/show/home:mnhauke/detect-it-easy (Thanks Martin Hauke)
Detect-It-Easy can be downloaded from the [release](https://github.com/horsicq/DIE-engine/releases) page.
Telegram Bot
=======
### Portable version (Linux)
```bash
wget https://github.com/horsicq/DIE-engine/releases/download/3.08/Detect_It_Easy-3.08-x86_64.AppImage
```
# Installing
### Using installation packages
- Windows: [die](https://community.chocolatey.org/packages/die) on Chocolatey (Thanks [**chtof**](https://github.com/chtof) and [**Rob Reynolds**](https://github.com/ferventcoder))
- Parrot OS: Package name **detect-it-easy** (Thanks [**Nong Hoang Tu**](https://github.com/dmknght))
- Arch Linux: Aur package [detect-it-easy-git](https://aur.archlinux.org/packages/detect-it-easy-git/) (Thanks [**Arnaud Dovi**](https://github.com/class101))
- [REMnux](https://remnux.org): (Thanks [**REMnux team**](https://twitter.com/REMnux/status/1401935989266919426))
- openSUSE: [detect-it-easy](https://build.opensuse.org/package/show/home:mnhauke/detect-it-easy) (Thanks Martin Hauke)
### Build from source
Build instructions can be found in [BUILD.md](docs/BUILD.md).
### Docker install
You can also run DIE with [Docker](https://www.docker.com/community-edition)! Of course, this requires that you have git and Docker installed.
```bash
git clone --recursive https://github.com/horsicq/Detect-It-Easy
cd Detect-It-Easy/
docker build . -t horsicq:diec
```
# Usage
### detect-it-easy has 3 variants
- `die` GUI version
- `diec` console version
- `diel` GUI lite version
Detailed usage instructions can be found in [RUN.md](docs/RUN.md).
# Telegram Bot
You could find the Bot in Telegram @detectiteasy_bot or simply enter in the search for Telegram "Detect It Easy"
Thanks to all the people who already contributed!
=======
# Thanks to all the people who already contributed!
<a href="https://github.com/horsicq/Detect-It-Easy/graphs/contributors">
<img src="https://contrib.rocks/image?repo=horsicq/Detect-It-Easy" />
@ -84,6 +113,3 @@ Thanks to all the people who already contributed!
- [PELock Software Protection & Reverse Engineering](https://www.pelock.com)
![alt text](https://github.com/horsicq/Detect-It-Easy/blob/master/mascots/logo.png "Mascot")

View file

@ -1,10 +1,10 @@
# How to build on Docker
git clone --recursive https://github.com/horsicq/DIE-engine.git
```bash
git clone https://github.com/horsicq/DIE-engine.git
cd DIE-engine
docker build .
docker build . -t horsicq:diec
```
# How to build on Linux based on Debian
@ -45,12 +45,6 @@ bash -x build_dpkg.sh
sudo dpkg -i release/$(ls release)
```
### Usage
```bash
die [FileName] or diec [FileName] or diel [FileName]
```
# How to build on Linux(Automake)
### Qt framework has to be installed on the system.
@ -79,12 +73,6 @@ make -j4
sudo make install
```
### Usage
```bash
die [FileName] or diec [FileName] or diel [FileName]
```
# How to build on OSX
Install Qt 5.15.2: https://github.com/horsicq/build_tools
@ -143,4 +131,6 @@ mkdir -p build
cmake . -B build
cd build
make -j4
# To use it as a command, uncomment the following line:
# sudo make install -j4
```

View file

@ -1,33 +1,29 @@
* die GUI version
* diec console version
* diel GUI lite version
# Instructions to run Detect It Easy
### Linux Package/Build
How to run portable version on Linux
=======
```bash
die [FileName] or diec [FileName] or diel [FileName]
```
* download an appImage file https://github.com/horsicq/DIE-engine/releases/download/3.08/Detect_It_Easy-3.08-x86_64.AppImage
* make the file executable (chmod +x Detect_It_Easy-3.08-x86_64.AppImage)
* run it (./Detect_It_Easy-3.08-x86_64.AppImage)
### Portable version on Linux
Run with Docker
=======
Make the file executable
You can also run DIE with [Docker](https://www.docker.com/community-edition)! Of course, this requires that you have git and Docker installed.
```bash
chmod +x Detect_It_Easy-3.08-x86_64.AppImage
```
Run it
```bash
./Detect_It_Easy-3.08-x86_64.AppImage
```
### Run with Docker
Here's how to use DIE with Docker:
```bash
git clone --recursive https://github.com/horsicq/Detect-It-Easy
cd Detect-It-Easy/
docker build . -t horsicq:diec
docker/diec.sh ~/example/infected.exe
filetype: PE32
arch: I386
mode: 32
endianess: LE
type: GUI
protector: Themida/Winlicense(2.X)[-]
linker: Turbo Linker(2.25*,Delphi)[GUI32]
docker/diec.sh [FileName]
```