mirror of
https://github.com/rizinorg/cutter.git
synced 2025-01-18 18:38:51 +00:00
Update README.md
This commit is contained in:
parent
709d20105e
commit
0a8755f471
33
README.md
33
README.md
@ -2,7 +2,7 @@
|
||||
[![Build Status](https://travis-ci.org/radareorg/cutter.svg?branch=master)](https://travis-ci.org/radareorg/cutter)
|
||||
[![Build status](https://ci.appveyor.com/api/projects/status/s9rkx1dn3uy4bfdx/branch/master?svg=true)](https://ci.appveyor.com/project/radare/cutter/branch/master)
|
||||
|
||||
A Qt and C++ GUI for radare2 reverse engineering framework (originally Iaito)
|
||||
A Qt and C++ GUI for radare2 reverse engineering framework (originally named Iaito).
|
||||
|
||||
## Screenshot
|
||||
|
||||
@ -12,22 +12,21 @@ A Qt and C++ GUI for radare2 reverse engineering framework (originally Iaito)
|
||||
|
||||
Cutter is not aimed at existing radare2 users. It instead focuses on those whose are not yet radare2 users because of the learning curve, because they don't like CLI applications or because of the difficulty/instability of radare2.
|
||||
|
||||
**IMPORTANT:** the current status is **highly unstable**, it is an alpha version aimed for developers. Users please wait for the first stable release with installers.
|
||||
## Installing
|
||||
|
||||
## Requirements
|
||||
### Downloading a release
|
||||
|
||||
**You do not have to do this if you are using a [release](https://github.com/radareorg/cutter/releases) since r2 is included in those!**
|
||||
You can download the latest release [here](https://github.com/radareorg/cutter/releases).
|
||||
|
||||
- **Radare2**: Make sure that, when cloning the project, you use `git clone --recurse-submodules` or run `git submodule update --init` to clone the correct radare2 version. Then execute the following command in the radare2 folder:
|
||||
```
|
||||
sys/install.sh
|
||||
```
|
||||
### Building from source
|
||||
|
||||
- QtCreator and Qt: Right now *cutter* uses Qt 5.9.1, you will need the latest QtCreator and Qt added during the installation:
|
||||
- Download: [Qt Open Source](https://info.qt.io/download-qt-for-application-development)
|
||||
- Add Qt 5.9.1: http://doc.qt.io/qtcreator/creator-project-qmake.html
|
||||
#### Requirements
|
||||
|
||||
## Building from source
|
||||
Cutter is based on Qt so you will need to have it installed.
|
||||
- Download: [Qt Open Source](https://info.qt.io/download-qt-for-application-development)
|
||||
- Add Qt 5.9.1: http://doc.qt.io/qtcreator/creator-project-qmake.html
|
||||
|
||||
#### Building
|
||||
|
||||
First you must clone the repository:
|
||||
```sh
|
||||
@ -35,18 +34,18 @@ git clone https://github.com/radareorg/cutter
|
||||
cd cutter
|
||||
```
|
||||
|
||||
### Building radare2
|
||||
##### Building radare2
|
||||
```sh
|
||||
git submodule init radare2 && git submodule update radare2
|
||||
cd radare2 && ./sys/install.sh
|
||||
cd ..
|
||||
```
|
||||
|
||||
### Building cutter
|
||||
##### Building cutter
|
||||
|
||||
Cutter can be build with two methods: The preferred one is with qmake, but you can also compile it with cmake. Choose the one you want to use.
|
||||
|
||||
#### Method 1: Qmake
|
||||
- Method 1: Qmake
|
||||
```sh
|
||||
mkdir build
|
||||
cd build
|
||||
@ -54,7 +53,7 @@ qmake ../src
|
||||
make
|
||||
```
|
||||
|
||||
#### Method 2: CMake
|
||||
- Method 2: CMake
|
||||
```sh
|
||||
cd src
|
||||
mkdir build
|
||||
@ -68,7 +67,7 @@ Then run cutter: `./cutter` or `./build/cutter`
|
||||
Note: If radare2 is not installed system-wide (`./sys/user.sh` installation for instance) you might want to use `LD_LIBRARY_PATH=$HOME/bin/prefix/radare2/lib ./cutter` to run cutter.
|
||||
|
||||
|
||||
## Troubleshoting
|
||||
## Troubleshooting
|
||||
|
||||
On Mac, QT5 apps fail to build on QtCreator if you have the libjpeg lib installed with brew. Run this command to workaround the issue:
|
||||
|
||||
|
Loading…
Reference in New Issue
Block a user