cutter/README.md

# Cutter [![Build Status](https://travis-ci.org/radareorg/cutter.svg?branch=master)](https://travis-ci.org/radareorg/cutter)

A Qt and C++ GUI for radare2 reverse engineering framework (originally Iaito)

## Screenshot

![Screenshot](https://raw.githubusercontent.com/radareorg/cutter/master/Screenshots/Screenshot.png)

## Disclaimer

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.

**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
```

- 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

## Platforms

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.

Roadmap information for developers can be found [here](docs/Roadmap.md).

## Help

Right now the best place to obtain help from *cutter* developers and community is joining this telegram group:

- https://t.me/iaito
Renamed Iaito to Cutter 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)`
Update README Basic project information added 2017-03-29 08:57:19 +00:00
Update README.md 2017-09-26 16:14:57 +00:00			`A Qt and C++ GUI for radare2 reverse engineering framework (originally Iaito)`
Update README Basic project information added 2017-03-29 08:57:19 +00:00
Added screenshot Mandatory to have a screenshot in the README for a GUI 2017-03-29 10:26:06 +00:00			`## Screenshot`

Renamed Iaito to Cutter 2017-09-25 12:55:41 +00:00			`![Screenshot](https://raw.githubusercontent.com/radareorg/cutter/master/Screenshots/Screenshot.png)`
Added screenshot Mandatory to have a screenshot in the README for a GUI 2017-03-29 10:26:06 +00:00
Update README Basic project information added 2017-03-29 08:57:19 +00:00			`## Disclaimer`

Renamed Iaito to Cutter 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.`
Update README Basic project information added 2017-03-29 08:57:19 +00:00
Update README.md 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.`
Updated README Added warning about the alpha status of the code 2017-03-29 19:42:08 +00:00
Update README Basic project information added 2017-03-29 08:57:19 +00:00			`## Requirements`

README.md: simplified requirements (#179) 2017-05-29 09:55:54 +00:00			- 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:
Update README Basic project information added 2017-03-29 08:57:19 +00:00			```
			`sys/install.sh`
			```
Updated Requirements in README 2017-03-31 09:37:01 +00:00
Renamed Iaito to Cutter 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:`
Fix Links in README (#12) 2017-09-28 16:43:02 +00:00			`- Download: [Qt Open Source](https://info.qt.io/download-qt-for-application-development)`
Modified Qt version in README 2017-09-23 13:57:39 +00:00			`- Add Qt 5.9.1: http://doc.qt.io/qtcreator/creator-project-qmake.html`
Update README Basic project information added 2017-03-29 08:57:19 +00:00
			`## Platforms`

Renamed Iaito to Cutter 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.`
Update README Basic project information added 2017-03-29 08:57:19 +00:00
			`## Documentation`

			`Proper documentation and website will be created before the first release.`
Added roadmap link 2017-03-29 12:33:32 +00:00
Fix Links in README (#12) 2017-09-28 16:43:02 +00:00			`Roadmap information for developers can be found [here](docs/Roadmap.md).`
Update README Closes #18 2017-03-30 08:43:36 +00:00
			`## Help`

Renamed Iaito to Cutter 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:`
Update README Closes #18 2017-03-30 08:43:36 +00:00
			`- https://t.me/iaito`