mirror of
https://github.com/rizinorg/cutter.git
synced 2024-12-18 19:06:10 +00:00
[skip ci] Improved building instructions (#1843)
This commit is contained in:
xarkes
Itay Cohen
parent
771217d70a
commit
afd63e97cd
@ -1,126 +1,87 @@
|
||||
Building
|
||||
========
|
||||
|
||||
First you must get the source of Cutter by cloning the repository:
|
||||
Below you will find the instructions for building Cutter.
|
||||
|
||||
|
||||
Building on Linux
|
||||
-----------------
|
||||
|
||||
Requirements
|
||||
~~~~~~~~~~~~
|
||||
|
||||
On Linux, you will need:
|
||||
|
||||
* build-essential
|
||||
* git
|
||||
* cmake
|
||||
* meson
|
||||
* libzip-dev
|
||||
* libzlib-dev
|
||||
* qt5
|
||||
* qt5-svg
|
||||
* pkgconf
|
||||
|
||||
On some Linux distributions, all of those packages can be installed with this single command:
|
||||
|
||||
::
|
||||
|
||||
sudo apt install git build-essential cmake meson libzip-dev zlib1g-dev qt5-default libqt5svg5-dev
|
||||
|
||||
Building steps
|
||||
~~~~~~~~~~~~~~
|
||||
|
||||
The official way to build Cutter on Linux is by using CMake.
|
||||
First clone the repository with its dependencies:
|
||||
|
||||
::
|
||||
|
||||
git clone --recurse-submodules https://github.com/radareorg/cutter
|
||||
|
||||
The “official” way to build Cutter is by using qmake, but there are two
|
||||
alternatives – cmake and meson.
|
||||
|
||||
In any case, there are obviously some requirements:
|
||||
|
||||
* Radare2 installed from submodule
|
||||
* Qt 5.9 or above (can compile using 5.5 with some limitations)
|
||||
* Python3.6
|
||||
* Breakpad installed using script (optional, disabled by default)
|
||||
|
||||
Before compiling, note that we also provide binaries available for
|
||||
windows/linux/MacOS `here <https://github.com/radareorg/cutter/releases>`_.
|
||||
|
||||
--------------
|
||||
|
||||
Building options
|
||||
----------------
|
||||
|
||||
Note that there are three major building options available:
|
||||
|
||||
* ``CUTTER_ENABLE_PYTHON`` compile with Python support
|
||||
* ``CUTTER_ENABLE_PYTHON_BINDINGS`` automatically generate Python Bindings with Shiboken2, required for Python plugins!
|
||||
* ``CUTTER_ENABLE_CRASH_REPORTS`` is used to compile Cutter with crash handling system enabled (Breakpad)
|
||||
* ``CUTTER_USE_BUNDLED_RADARE2`` CMake only, automatically compile Radare2 from submodule.
|
||||
|
||||
--------------
|
||||
|
||||
Preparing Breakpad
|
||||
-------------------
|
||||
|
||||
If you want to build Cutter with crash handling system, you want prepare Breakpad before.
|
||||
For this simply run one of the scripts (according to your OS) from root Cutter directory:
|
||||
Then just use CMake to build Cutter and its dependency radare2.
|
||||
|
||||
.. code:: sh
|
||||
|
||||
source scripts/prepare_breakpad_linux.sh # Linux
|
||||
source scripts/prepare_breakpad_macos.sh # MacOS
|
||||
scripts/prepare_breakpad.bat # Windows
|
||||
cd cutter/src
|
||||
mkdir build
|
||||
cmake -B build -DCUTTER_USE_BUNDLED_RADARE2=ON
|
||||
cmake --build build
|
||||
|
||||
Then if you are building on Linux you want to change ``PKG_CONFIG_PATH`` environment variable
|
||||
so it contains ``$CUSTOM_BREAKPAD_PREFIX/lib/pkgconfig``. For this simply run
|
||||
|
||||
If you are interested in building Cutter with support for Python plugins,
|
||||
Syntax Highlighting, Crash Reporting and more,
|
||||
please look at the full list of `CMake Building Options`_.
|
||||
|
||||
After the build process is complete, you should be provided with Cutter executable
|
||||
that you can start like this:
|
||||
|
||||
.. code:: sh
|
||||
|
||||
export PKG_CONFIG_PATH="$CUSTOM_BREAKPAD_PREFIX/lib/pkgconfig:$PKG_CONFIG_PATH"
|
||||
./build/Cutter
|
||||
|
||||
|
||||
--------------
|
||||
|
||||
Building with Qmake
|
||||
-------------------
|
||||
|
||||
Compiling on Linux / macOS
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
The easy way is to simply run ``./build.sh`` from the root directory,
|
||||
and let the magic happen. The script will use qmake to build Cutter.
|
||||
|
||||
If you want to manually use qmake, follow this steps:
|
||||
|
||||
.. code:: sh
|
||||
|
||||
mkdir build; cd build
|
||||
qmake ../src/Cutter.pro
|
||||
make
|
||||
cd ..
|
||||
|
||||
Additional steps for macOS
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
On macOS you will also have to copy the launcher bash script:
|
||||
|
||||
.. code:: sh
|
||||
|
||||
mv Cutter.app/Contents/MacOS/Cutter Cutter.app/Contents/MacOS/Cutter.bin
|
||||
cp ../src/macos/Cutter Cutter.app/Contents/MacOS/Cutter && chmod +x Cutter.app/Contents/MacOS/Cutter
|
||||
|
||||
--------------
|
||||
|
||||
Building with Cmake
|
||||
Building on Windows
|
||||
-------------------
|
||||
|
||||
Requirements
|
||||
~~~~~~~~~~~~
|
||||
|
||||
- CMake >= 3.5 (recommended >= 3.6)
|
||||
Cutter works on Windows starting from Windows 7 up to Windows 10.
|
||||
To compile Cutter it is necessary to have installed:
|
||||
|
||||
Building on Linux
|
||||
~~~~~~~~~~~~~~~~~
|
||||
* A version of Visual Studio (2015, 2017 and 2019 are supported)
|
||||
* CMake
|
||||
* Qt
|
||||
|
||||
The root for CMake is in src/. In-source builds are **not allowed**, so
|
||||
you **must** run CMake from a separate directory:
|
||||
Default way
|
||||
~~~~~~~~~~~
|
||||
|
||||
.. code:: sh
|
||||
To build Cutter on Windows machines using CMake,
|
||||
you will have to make sure that the executables are available
|
||||
in your `%PATH%` environment variable.
|
||||
|
||||
cd src
|
||||
mkdir build
|
||||
cd build
|
||||
cmake .. # Don't forget to provide build options
|
||||
|
||||
If all went well, you should now have a working Makefile in your build
|
||||
directory:
|
||||
|
||||
::
|
||||
|
||||
make
|
||||
|
||||
--------------
|
||||
|
||||
Building on Windows
|
||||
-------------------
|
||||
|
||||
Alternatively, on Windows you can run something like this (depending on
|
||||
your Cmake installation)
|
||||
Note that the paths below may vary depending on your version of Qt and Visual Studio.
|
||||
|
||||
.. code:: batch
|
||||
|
||||
@ -130,33 +91,20 @@ your Cmake installation)
|
||||
cd build
|
||||
cmake-gui ..
|
||||
|
||||
Click ``Configure`` and select ``Visual Studio 14 2015`` from the list.
|
||||
Click ``Configure`` and select your version of Visual Studio from the list,
|
||||
for example ``Visual Studio 14 2015``.
|
||||
After configuration is done, click ``Generate`` and you can open
|
||||
``Cutter.sln`` to compile the code as usual.
|
||||
|
||||
Troubleshooting
|
||||
---------------
|
||||
|
||||
Cmake: qt development package not found
|
||||
Building with Meson
|
||||
~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
Depending on how Qt installed (Distribution packages or using the Qt
|
||||
installer application), CMake may not be able to find it by itself if it
|
||||
is not in a common place. If that is the case, double check that the
|
||||
correct Qt version is installed. Locate its prefix (a directory
|
||||
containing bin/, lib/, include/, etc.) and specify it to CMake using
|
||||
``CMAKE_PREFIX_PATH`` in the above process, e.g.:
|
||||
|
||||
::
|
||||
|
||||
rm CMakeCache.txt # the cache may be polluted with unwanted libraries found before
|
||||
cmake -DCMAKE_PREFIX_PATH=/opt/Qt/5.9.1/gcc_64 ..
|
||||
|
||||
Building with Meson (Windows)
|
||||
-----------------------------
|
||||
There is another way to compile Cutter on Windows, if the one above does
|
||||
not work or does not suit your needs.
|
||||
|
||||
Additional requirements:
|
||||
|
||||
- Visual Studio 2015 or Visual Studio 2017
|
||||
- Ninja build system
|
||||
- Meson build system
|
||||
|
||||
@ -164,6 +112,8 @@ Download and unpack
|
||||
`Ninja <https://github.com/ninja-build/ninja/releases>`__ to the Cutter
|
||||
source root directory.
|
||||
|
||||
Note that in the below steps, the paths may vary depending on your version of Qt and Visual Studio.
|
||||
|
||||
Environment settings (example for x64 version):
|
||||
|
||||
.. code:: batch
|
||||
@ -187,3 +137,119 @@ To compile Cutter run:
|
||||
|
||||
CALL prepare_r2.bat
|
||||
CALL build.bat
|
||||
|
||||
|
||||
--------------
|
||||
|
||||
Building with Qmake
|
||||
-------------------
|
||||
|
||||
Using QtCreator
|
||||
~~~~~~~~~~~~~~~
|
||||
|
||||
One standard way is to simply load the project inside QtCreator.
|
||||
To do so, open QtCreator and on the welcome screen click on "Open Project",
|
||||
and finally select the ``cutter/src/Cutter.pro`` file.
|
||||
QtCreator will then allow you to directly edit the source code and build the project.
|
||||
|
||||
.. note::
|
||||
|
||||
For the `.pro` file to be compiled successfully, it is required
|
||||
to run `prepare_r2.bat` beforehand.
|
||||
|
||||
Compiling on Linux / macOS
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
The easiest way, but not the one we recommend, is to simply run ``./build.sh`` from the root directory,
|
||||
and let the magic happen. The script will use qmake to build Cutter.
|
||||
The ``build.sh`` script is meant to be deprecated and will be deleted in the future.
|
||||
|
||||
If you want to manually use qmake, follow these steps:
|
||||
|
||||
.. code:: sh
|
||||
|
||||
mkdir build; cd build
|
||||
qmake ../src/Cutter.pro
|
||||
make
|
||||
cd ..
|
||||
|
||||
Additional steps for macOS
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
On macOS you will also have to copy the launcher bash script:
|
||||
|
||||
.. code:: sh
|
||||
|
||||
mv Cutter.app/Contents/MacOS/Cutter Cutter.app/Contents/MacOS/Cutter.bin
|
||||
cp ../src/macos/Cutter Cutter.app/Contents/MacOS/Cutter && chmod +x Cutter.app/Contents/MacOS/Cutter
|
||||
|
||||
|
||||
--------------
|
||||
|
||||
CMake Building Options
|
||||
----------------------
|
||||
|
||||
Note that there are some major building options available:
|
||||
|
||||
* ``CUTTER_USE_BUNDLED_RADARE2`` automatically compile Radare2 from submodule.
|
||||
* ``CUTTER_ENABLE_PYTHON`` compile with Python support.
|
||||
* ``CUTTER_ENABLE_PYTHON_BINDINGS`` automatically generate Python Bindings with Shiboken2, required for Python plugins!
|
||||
* ``CUTTER_ENABLE_KSYNTAXHIGHLIGHTING`` use KSyntaxHighlighting for code highlighting.
|
||||
* ``CUTTER_ENABLE_GRAPHVIZ`` enable Graphviz for graph layouts.
|
||||
* ``CUTTER_ENABLE_CRASH_REPORTS`` is used to compile Cutter with crash handling system enabled (Breakpad).
|
||||
|
||||
These options can be enabled or disabled from the command line arguments passed to CMake.
|
||||
For example, in order to build Cutter with support for Python plugins, you can run this command:
|
||||
|
||||
::
|
||||
|
||||
cmake -B build -DCUTTER_ENABLE_PYTHON=ON -DCUTTER_ENABLE_PYTHON_BINDINGS=ON
|
||||
|
||||
Or if one wants to explicitely disable an option:
|
||||
|
||||
::
|
||||
|
||||
cmake -B build -DCUTTER_ENABLE_PYTHON=OFF
|
||||
|
||||
|
||||
--------------
|
||||
|
||||
Compiling Cutter with Breakpad support
|
||||
--------------------------------------
|
||||
|
||||
If you want to build Cutter with crash handling system, you want prepare Breakpad before.
|
||||
For this simply run one of the scripts (according to your OS) from root Cutter directory:
|
||||
|
||||
.. code:: sh
|
||||
|
||||
source scripts/prepare_breakpad_linux.sh # Linux
|
||||
source scripts/prepare_breakpad_macos.sh # MacOS
|
||||
scripts/prepare_breakpad.bat # Windows
|
||||
|
||||
Then if you are building on Linux you want to change ``PKG_CONFIG_PATH`` environment variable
|
||||
so it contains ``$CUSTOM_BREAKPAD_PREFIX/lib/pkgconfig``. For this simply run
|
||||
|
||||
.. code:: sh
|
||||
|
||||
export PKG_CONFIG_PATH="$CUSTOM_BREAKPAD_PREFIX/lib/pkgconfig:$PKG_CONFIG_PATH"
|
||||
|
||||
|
||||
--------------
|
||||
|
||||
Troubleshooting
|
||||
---------------
|
||||
|
||||
Cmake: qt development package not found
|
||||
|
||||
Depending on how Qt installed (Distribution packages or using the Qt
|
||||
installer application), CMake may not be able to find it by itself if it
|
||||
is not in a common place. If that is the case, double check that the
|
||||
correct Qt version is installed. Locate its prefix (a directory
|
||||
containing bin/, lib/, include/, etc.) and specify it to CMake using
|
||||
``CMAKE_PREFIX_PATH`` in the above process, e.g.:
|
||||
|
||||
::
|
||||
|
||||
rm CMakeCache.txt # the cache may be polluted with unwanted libraries found before
|
||||
cmake -DCMAKE_PREFIX_PATH=/opt/Qt/5.9.1/gcc_64 ..
|
||||
|
||||
|
||||
@ -15,7 +15,7 @@ option(CUTTER_ENABLE_PYTHON "Enable Python integration. Requires Python >= ${CUT
|
||||
option(CUTTER_ENABLE_PYTHON_BINDINGS "Enable generating Python bindings with Shiboken2. Unused if CUTTER_ENABLE_PYTHON=OFF." OFF)
|
||||
option(CUTTER_ENABLE_CRASH_REPORTS "Enable crash report system. Unused if CUTTER_ENABLE_CRASH_REPORTS=OFF" OFF)
|
||||
tri_option(CUTTER_ENABLE_KSYNTAXHIGHLIGHTING "Use KSyntaxHighlighting" AUTO)
|
||||
tri_option(CUTTER_ENABLE_GRAPHVIZ "Enable use of gprahviz for graph layout" AUTO)
|
||||
tri_option(CUTTER_ENABLE_GRAPHVIZ "Enable use of graphviz for graph layout" AUTO)
|
||||
|
||||
if(NOT CUTTER_ENABLE_PYTHON)
|
||||
set(CUTTER_ENABLE_PYTHON_BINDINGS OFF)
|
||||
|
||||
Loading…
Reference in New Issue
Block a user