Merge pull request #172 from mdhvg/docs/format-build-instructions

Docs/format build instructions
This commit is contained in:
Hors 2023-10-05 08:03:27 +02:00 committed by GitHub
commit f475885762
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
7 changed files with 105 additions and 64 deletions

View file

@ -8,42 +8,82 @@ docker build .
# How to build on Linux based on Debian
Install packages:
#### Install packages:
- sudo apt-get install qtbase5-dev -y
- sudo apt-get install qtscript5-dev -y
- sudo apt-get install qttools5-dev-tools -y
- sudo apt-get install libqt5svg5-dev -y
- sudo apt-get install git -y
- sudo apt-get install build-essential -y
- sudo apt-get install qt5-default -y (Ubuntu 14.04-20.04)
- sudo apt-get install qtchooser -y (Ubuntu 21.04-22.04)
- sudo apt-get install qt5-qmake -y (Ubuntu 21.04-22.04)
```bash
sudo apt-get install qtbase5-dev qtscript5-dev qttools5-dev-tools libqt5svg5-dev git build-essential -y
```
- Ubuntu 14.04-20.04:
```bash
sudo apt-get install qt5-default -y
```
- Ubuntu 21.04-22.04
```bash
sudo apt-get install qtchooser qt5-qmake -y
```
#### Clone this repo recursively:
```bash
git clone --recursive https://github.com/horsicq/DIE-engine.git
cd DIE-engine
```
Run build script: bash -x build_dpkg.sh
#### Run build script:
Install deb package: sudo dpkg -i release/die_[Version].deb
```bash
bash -x build_dpkg.sh
```
Run DiE: *die [FileName] or diec [FileName] or diel [FileName]*
#### Install deb package:
```bash
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.
### Qt framework has to be installed on the system.
(Ubuntu)Install Qt Framework: **sudo apt-get install --quiet --assume-yes build-essential qt5-default qtbase5-dev qttools5-dev-tools qtscript5-dev libqt5svg5-dev**
#### (Ubuntu) Install Qt Framework:
Clone project: git clone --recursive https://github.com/horsicq/DIE-engine.git
```bash
sudo apt-get install --quiet --assume-yes build-essential qt5-default qtbase5-dev qttools5-dev-tools qtscript5-dev libqt5svg5-dev
```
- chmod a+x configure
- ./configure
- make
- sudo make install
#### Clone this repo recursively:
Run DiE: *die [FileName] or diec [FileName] or diel [FileName]*
```bash
git clone --recursive https://github.com/horsicq/DIE-engine.git
cd DIE-engine
```
#### Build
Might require sudo privileges
```bash
chmod a+x configure
./configure
make -j4
sudo make install
```
### Usage
```bash
die [FileName] or diec [FileName] or diel [FileName]
```
# How to build on OSX
@ -65,7 +105,7 @@ Install 7-Zip: https://github.com/horsicq/build_tools
Clone project: git clone --recursive https://github.com/horsicq/DIE-engine.git
Edit build_winxp.bat ( check VSVARS_PATH, SEVENZIP_PATH, QMAKE_PATH variables)
Edit build_winxp.bat ( check VSVARS_PATH, SEVENZIP_PATH, QMAKE_PATH variables)
Run build_winxp.bat
@ -79,19 +119,28 @@ Install 7-Zip: https://github.com/horsicq/build_tools
Clone project: git clone --recursive https://github.com/horsicq/DIE-engine.git
Edit build_win32.bat ( check VSVARS_PATH, SEVENZIP_PATH, QMAKE_PATH variables)
Edit build_win32.bat ( check VSVARS_PATH, SEVENZIP_PATH, QMAKE_PATH variables)
Edit build_win64.bat ( check VSVARS_PATH, SEVENZIP_PATH, QMAKE_PATH variables)
Edit build_win64.bat ( check VSVARS_PATH, SEVENZIP_PATH, QMAKE_PATH variables)
Run build_win32.bat
Run build_win64.bat
# How to build with CMAKE
#### Clone this repo recursively:
```bash
git clone --recursive https://github.com/horsicq/DIE-engine.git
cd DIE-engine
```
cmake .
#### Build
make
```bash
mkdir -p build
cmake . -B build
cd build
make -j4
```