cutter/docs/source/index.rst

58 lines
1.4 KiB
ReStructuredText
Raw Normal View History

Cutter
======
2019-02-26 17:49:41 +00:00
Cutter is a Qt and C++ GUI for Rizin. Its goal is to provide an advanced,
2019-02-26 17:49:41 +00:00
customizable and FOSS reverse-engineering platform while keeping the
user experience in mind. Cutter was created by reverse engineers for
2019-02-26 17:49:41 +00:00
reverse engineers.
.. image:: images/screenshot.png
Getting Cutter
--------------
2019-02-26 17:49:41 +00:00
Cutter is available for all major platforms. You can
download the latest release from
`here <https://github.com/rizinorg/cutter/releases>`__.
- **macOS**: Download the ``.dmg`` file and install it.
- **Windows**: Download the ``.zip`` archive and extract it.
- **Linux**: Download the ``.AppImage`` file and make it executable by doing:
::
chmod +x Cutter*.AppImage
2019-02-26 17:49:41 +00:00
Building from Sources
2019-02-26 17:49:41 +00:00
---------------------
To build Cutter on your machine, please follow this guide: :doc:`Building from Source </building>`.
2019-02-26 17:49:41 +00:00
Need help?
----------
You can contact the *Cutter* developers and community on:
- Telegram: https://t.me/cutter_re
2019-02-26 17:49:41 +00:00
- #cutter on irc.freenode.net
- Twitter: https://twitter.com/cutter_re
2019-02-26 17:49:41 +00:00
Want to help the project?
-------------------------
If you want to contribute to Cutter, take a look at our :doc:`Contribution Guidelines </contributing>` to learn how you can help improve the project!
2019-02-07 13:45:01 +00:00
.. toctree::
:caption: Contents:
:maxdepth: 3
2019-02-08 16:34:46 +00:00
user-docs
contributing
Developer documentation <contributing/code>
2019-03-16 16:14:54 +00:00
building
plugins
api