ch0ic3/cutter
1
0
Fork 0
mirror of https://github.com/rizinorg/cutter.git synced 2024-12-18 10:56:11 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Improve README (#2502)

Browse Source
This commit is contained in:
Surendrajat 2020-12-13 01:22:34 +05:30 committed by GitHub
parent 3cab4134b6
commit eefaabd30f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 31 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

50
README.md
View File

@ -2,7 +2,7 @@
# Cutter
Cutter is a free and open-source reverse engineering framework powered by [rizin](https://github.com/rizinorg/rizin) . Its goal is making an advanced, customizable and FOSS reverse-engineering platform while keeping the user experience in mind. Cutter is created by reverse engineers for reverse engineers.
Cutter is a free and open-source reverse engineering platform powered by [rizin](https://github.com/rizinorg/rizin). It aims at being an advanced and customizable reverse engineering platform while keeping the user experience in mind. Cutter is created by reverse engineers for reverse engineers.
[![Cutter CI](https://github.com/rizinorg/cutter/workflows/Cutter%20CI/badge.svg)](https://github.com/rizinorg/cutter/actions?query=workflow%3A%22Cutter+CI%22)
[![Build status](https://ci.appveyor.com/api/projects/status/tn7kttv55b8wf799/branch/master?svg=true)](https://ci.appveyor.com/project/rizinorg/cutter/branch/master)
@ -10,39 +10,51 @@ Cutter is a free and open-source reverse engineering framework powered by [rizin
![Screenshot](https://raw.githubusercontent.com/rizinorg/cutter/master/docs/source/images/screenshot.png)
## Learn more at [https://cutter.re](https://cutter.re).
## Learn more at [cutter.re](https://cutter.re).
## Downloading a release
## Getting Cutter
### Download
Cutter is available for all platforms (Linux, macOS, Windows).
You can download the latest release [here](https://github.com/rizinorg/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>`
Cutter release binaries for all major platforms (Linux, macOS, Windows) can be downloaded from [GitHub Releases](https://github.com/rizinorg/cutter/releases).
## Building from sources
- **Linux**: Download the `.AppImage` file. Then make it executable and run as below or use [AppImageLauncher](https://github.com/TheAssassin/AppImageLauncher).
To build Cutter on your local machine, please follow this guide: [Building from source](https://cutter.re/docs/building.html)
`chmod +x Cutter*.AppImage; ./Cutter*.AppImage`
- **macOS**: Download the `.dmg` file or use [Homebrew Cask](https://github.com/Homebrew/homebrew-cask):
## Docker
`brew cask install cutter`
- **Windows**: Download the `.zip` archive or use [Chocolatey](https://chocolatey.org):
`choco install cutter`
### Build from sources
To build Cutter from sources, please check the [Building Docs](https://cutter.re/docs/building.html).
### Docker image
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 in our [website](https://cutter.re/docs/).
### [User Guide](https://cutter.re/docs/user-docs.html)
### [Contribution Guidelines](https://cutter.re/docs/contributing.html)
### [Developers Docs](https://cutter.re/docs/contributing/code.html)
## Plugins
Cutter supports both Python and Native C++ plugins. Want to extend Cutter with Plugins? Read the [Plugins](https://cutter.re/docs/plugins) section on our documentation.
Cutter supports both Python and Native C++ plugins.
### Official and Community Plugins
Our community has built many plugins and useful scripts for Cutter such as the native integration of Ghidra decompiler or the plugin to visualize DynamoRIO code coverage. You can find more plugins in the [following list](https://github.com/rizinorg/cutter-plugins). Don't hesitate to extend it with your own plugins and scripts for Cutter.
Our community has built many plugins and useful scripts for Cutter such as the native integration of [Ghidra decompiler](https://github.com/rizinorg/rz-ghidra) or the plugin to visualize DynamoRIO code coverage. You can find a list of cutter plugins linked below. Feel free to extend it with your own plugins and scripts for Cutter.
## Help
**[Official & Community Plugins](https://github.com/rizinorg/cutter-plugins)**
The best place to obtain help from *Cutter* developers and community is to contact us on:
**[Plugins Development Guide]()**
## Getting Help
Please use the following channels to ask for help from Cutter developers and community:
- **Telegram:** https://t.me/cutter_re
- **Mattermost:** https://im.rizin.re