cutter/README.md

45 lines
1.8 KiB
Markdown
Raw Normal View History

2017-09-25 12:55:41 +00:00
# Cutter [![Build Status](https://travis-ci.org/radareorg/cutter.svg?branch=master)](https://travis-ci.org/radareorg/cutter)
2017-09-26 16:14:57 +00:00
A Qt and C++ GUI for radare2 reverse engineering framework (originally Iaito)
## Screenshot
2017-10-01 19:31:01 +00:00
![Screenshot](https://raw.githubusercontent.com/radareorg/cutter/master/docs/screenshot.png)
## Disclaimer
2017-09-25 12:55:41 +00:00
Cutter is not aimed at existing radare2 users, it is focused on those whose are not yet radare2 users because of the learning curve, they don't like CLI applications or the difficulty/instability of radare2.
2017-03-31 10:28:13 +00:00
**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.
## Requirements
- **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
```
2017-03-31 09:37:01 +00:00
2017-09-25 12:55:41 +00:00
- QtCreator and Qt: Right now *cutter* uses Qt 5.9.1, you will need the latest QtCreator and Qt added during the installation:
2017-09-28 16:43:02 +00:00
- Download: [Qt Open Source](https://info.qt.io/download-qt-for-application-development)
2017-09-23 13:57:39 +00:00
- Add Qt 5.9.1: http://doc.qt.io/qtcreator/creator-project-qmake.html
## Troubleshoting
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:
sudo mv /usr/local/lib/libjpeg.dylib /usr/local/lib/libjpeg.dylib.not-found
## Platforms
2017-09-25 12:55:41 +00:00
Cutter is developed on OS X, Linux and Windows. The first release for users will include installers for all three platforms.
## Documentation
Proper documentation and website will be created before the first release.
2017-03-29 12:33:32 +00:00
2017-03-30 08:43:36 +00:00
## Help
2017-09-25 12:55:41 +00:00
Right now the best place to obtain help from *cutter* developers and community is joining this telegram group:
2017-03-30 08:43:36 +00:00
- https://t.me/iaito