cutter/README.md

47 lines
2.0 KiB
Markdown
Raw Normal View History

# Iaitō
> The GUI that ~~radare2~~ humans deserve
2017-03-28 17:27:12 +00:00
A Qt and C++ GUI for radare2 reverse engineering framework
## Screenshot
![Screenshot](https://raw.githubusercontent.com/hteso/iaito/master/Screenshots/Screenshot.png)
## Disclaimer
Iaitō is not aimed to the already existing radare2 user, it is focused 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/inestability 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.
## The code sucks
Yes, the code sucks. Hopefully we will be able to remove this statement from the README one day, but I had never coded Qt nor C++ until I started Iaitō, so obviously the code is ugly and not well designed.
## Requirements
2017-03-31 09:37:01 +00:00
- **Radare2**: Make sure that, when cloning the project, you use `git clone --recurse-submodules` or run `git submodule init` and `git submodule update` 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
- QtCreator and Qt: Right now Iaitō uses Qt 5.3. It will be updated in the near future, but in the meantime the latest QtCreator needs to be installed and Qt 5.3 added during the installation:
- Download: https://www.qt.io/ide/
- Add Qt 5.3: http://doc.qt.io/qtcreator/creator-project-qmake.html
## Platforms
Iaitō is developed and tested in OS X, Linux and [Windows](https://github.com/hteso/iaito/wiki/Compiling-on-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
Roadmap information for developers can be found [here](https://github.com/hteso/iaito/wiki/Roadmap).
2017-03-30 08:43:36 +00:00
## Help
Right now the best place to obtain help from Iaitō developers and community is joining this telegram group:
- https://t.me/iaito