cutter/README.md

# Cutter
[![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)

Cutter is a Qt and C++ GUI for radare2. Its goal is making an advanced, customizable and FOSS reverse-engineering platform while keeping the user experience at mind. Cutter is created by reverse engineers for reverse engineers.

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

# Disclaimer

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.

# Downloading a release

Cutter is available for all platforms (Linux, OS X, Windows).
You can download the latest release [here](https://github.com/radareorg/cutter/releases).
 * OSX: Download the latest `.dmg` file.
 * Windows: Download the latest archive.
 * Linux: use the [AppImage](https://github.com/radareorg/cutter/releases/download/v1.7.2/Cutter-v1.7.2-x86_64.AppImage) file. Then just make it executable and run it:
     * `chmod +x Cutter-v1.7.2-x86_64.AppImage`
     * `./Cutter-v1.7.2-x86_64.AppImage`

## Building from sources

To build Cutter on your local machine, please follow this guide: [Building from source](https://radareorg.github.io/cutter/building.html)

## Docker

To deploy *cutter* using a pre-built `Dockerfile`, it's possible to use the [provided configuration](docker). The corresponding `README.md` file also contains instructions on how to get started using the docker image with minimal effort.

# Documentation

You can find our documentation [here](https://radareorg.github.io/cutter/).

# Help

Right now the best place to obtain help from *Cutter* developers and community is to contact us on:

- https://t.me/r2cutter
- #cutter on irc.freenode.net
- [@r2gui](https://twitter.com/r2gui) on Twitter
Added appveyor badge 2017-10-03 12:45:29 +00:00			`# Cutter`
			`[![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)`
Update README Basic project information added 2017-03-29 08:57:19 +00:00
Improve README 2018-10-08 10:51:16 +00:00			`Cutter is a Qt and C++ GUI for radare2. Its goal is making an advanced, customizable and FOSS reverse-engineering platform while keeping the user experience at mind. Cutter is created by reverse engineers for reverse engineers.`
Update README Basic project information added 2017-03-29 08:57:19 +00:00
Fix link to screenshot so it displays. (#731) (Issue presumably caused by recent documentation reorganisation.) 2018-09-29 19:33:44 +00:00			`![Screenshot](https://raw.githubusercontent.com/radareorg/cutter/master/docs/images/screenshot.png)`
Added screenshot Mandatory to have a screenshot in the README for a GUI 2017-03-29 10:26:06 +00:00
Improved documentation and README.md (#735) 2018-09-30 10:52:48 +00:00			`# Disclaimer`
Update README Basic project information added 2017-03-29 08:57:19 +00:00
Clarify/grammernaiz README.md 2017-10-14 18:25:23 +00:00			`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.`
Update README Basic project information added 2017-03-29 08:57:19 +00:00
Improved documentation and README.md (#735) 2018-09-30 10:52:48 +00:00			`# Downloading a release`
Update README Basic project information added 2017-03-29 08:57:19 +00:00
Update README.md 2018-03-07 10:47:00 +00:00			`Cutter is available for all platforms (Linux, OS X, Windows).`
Update README.md 2017-12-02 18:12:37 +00:00			`You can download the latest release [here](https://github.com/radareorg/cutter/releases).`
Improved documentation and README.md (#735) 2018-09-30 10:52:48 +00:00			* OSX: Download the latest `.dmg` file.
			`* Windows: Download the latest archive.`
Version bump (#777) 2018-10-07 20:45:47 +00:00			`* Linux: use the [AppImage](https://github.com/radareorg/cutter/releases/download/v1.7.2/Cutter-v1.7.2-x86_64.AppImage) file. Then just make it executable and run it:`
			* `chmod +x Cutter-v1.7.2-x86_64.AppImage`
			* `./Cutter-v1.7.2-x86_64.AppImage`
Clarify/grammernaiz README.md 2017-10-14 18:25:23 +00:00
Update README.md 2018-09-30 10:53:31 +00:00			`## Building from sources`

			`To build Cutter on your local machine, please follow this guide: [Building from source](https://radareorg.github.io/cutter/building.html)`
Updated Requirements in README 2017-03-31 09:37:01 +00:00
Improved documentation and README.md (#735) 2018-09-30 10:52:48 +00:00			`## Docker`
Removed docker.sh and added new docker related files into docker folder (#535) * Removed docker.sh and added new docker related files into docker folder 2018-06-25 09:43:59 +00:00
			To deploy cutter using a pre-built `Dockerfile`, it's possible to use the [provided configuration](docker). The corresponding `README.md` file also contains instructions on how to get started using the docker image with minimal effort.

Improved documentation and README.md (#735) 2018-09-30 10:52:48 +00:00			`# Documentation`
Debugging shortcuts (#578) * Added debug shortcuts and debug menu * Added "Add breakpoint" shortcut * Added debug shortcuts to readme * Fix double memorymap ui * Add bp F2 shortcut and fix toggling bp with shortcuts 2018-07-17 07:26:20 +00:00
Improved documentation and README.md (#735) 2018-09-30 10:52:48 +00:00			`You can find our documentation [here](https://radareorg.github.io/cutter/).`
DisassemblerGraphView: lots of additions.. (#213) * GraphView: Add refactored graphview with animations etc. * GraphView: Use new graphview and render background color. * DisassemblerGraphView: t/f navigation, zoom with +/-, bugfixes. 2017-12-13 22:38:46 +00:00
Improved documentation and README.md (#735) 2018-09-30 10:52:48 +00:00			`# Help`
Update README Closes #18 2017-03-30 08:43:36 +00:00
Improved documentation and README.md (#735) 2018-09-30 10:52:48 +00:00			`Right now the best place to obtain help from Cutter developers and community is to contact us on:`
Update README Closes #18 2017-03-30 08:43:36 +00:00
Update README.md (#67) Change link to telegram 2017-10-21 16:12:13 +00:00			`- https://t.me/r2cutter`
Added irc channel to readme 2017-10-04 11:37:35 +00:00			`- #cutter on irc.freenode.net`
Add twitter 2018-02-25 08:53:29 +00:00			`- [@r2gui](https://twitter.com/r2gui) on Twitter`