cutter/README.md
nico 697eb66aba update the README closes #1182 (#1187)
* update the README closes #1182

added Homebrew Cask installation method for macOS

* Update README.md

* Update README.md
2019-02-13 06:38:58 +00:00

43 lines
2.0 KiB
Markdown

<img width="150" height="150" align="left" style="float: left; margin: 0 10px 0 0;" alt="Cutter logo" src="https://raw.githubusercontent.com/radareorg/cutter/master/src/img/cutter.svg?sanitize=true">
# Cutter
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.
[![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)
![Screenshot](https://raw.githubusercontent.com/radareorg/cutter/master/docs/images/screenshot.png)
# Downloading a release
Cutter is available for all platforms (Linux, macOS, Windows).
You can download the latest release [here](https://github.com/radareorg/cutter/releases).
* macOS: Download the latest `.dmg` file or use [Homebrew Cask](https://github.com/Homebrew/homebrew-cask) `brew cask install cutter`.
* Windows: Download the latest Zip archive.
* Linux: Download the latest AppImage file. Then just make it executable and run it:
* `chmod +x <appimage_file>`
* `./<appimage_file>`
## 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