Rearranged documentation (#730)

This commit is contained in:
xarkes 2018-09-29 12:43:08 +02:00 committed by GitHub
parent da6a79e30f
commit cb9d72dacd
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
8 changed files with 33 additions and 10 deletions

1
docs/.gitignore vendored Normal file
View File

@ -0,0 +1 @@
_site/

View File

@ -1 +1,12 @@
title: Cutter
description: >-
Cutter is a Qt and C++ graphical user interface for the reverse
engineering framework radare2.
twitter_username: r2gui
github_username: radareorg
markdown: kramdown
remote_theme: allejo/jekyll-docs-theme
plugins:
- jekyll-remote-theme

View File

@ -23,14 +23,10 @@ To fix this, append:
to the `PATH` variable within the *Build Environment* section in Qt Creator. See the screenshot below should you encounter any problems.
![PATH variable settings](cutter_path_settings.png)
![PATH variable settings](images/cutter_path_settings.png)
Or radare2 libs could be installed to `/usr/lib/pkgconfig/`, so you can add variable `PKG_CONFIG_PATH` with value `/usr/lib/pkgconfig/`
### Keyboard layout issue
Some people report that they have keyboard issues. Usually it is because the Xorg layout is wrong. You can check it with:
```setxkbmap -query``` Most of the time using ```setxkbmap us``` solves the issue, but it might not be enough and require some more advanced Xorg configuration.
## Windows
See [Compiling on Windows](https://github.com/radareorg/cutter/blob/master/docs/Compiling-on-Windows.md).

View File

@ -3,7 +3,7 @@
Cutter supports different build systems:
* Building with qmake
* [Building with cmake](https://github.com/radareorg/cutter/blob/master/docs/Compiling-with-CMake.md)
* [Building with cmake](cmake.md)
* Building with meson (see ./meson.py)
Each time in the section below, the prefered method will be explained. For other methods check associated documentation.
@ -45,9 +45,7 @@ CALL "C:\Program Files (x86)\Microsoft Visual Studio 14.0\VC\vcvarsall.bat" x64
:: Add qmake to PATH
SET "PATH=C:\Qt\5.10.1\msvc2015_64\bin;%PATH%"
:: Add Python to PATH
SET "PATH=C:\Program Files\Python36;%PATH%"
```
SET "PATH=C:\Program Files\Python36;%PATH%" ```
Install Meson:
```batch
python -m pip install meson
@ -62,4 +60,4 @@ Pass `CUTTER_ENABLE_JUPYTER=false` argument to `build.bat` if you want to disabl
## It doesn't work!
Check this [page](https://github.com/radareorg/cutter/blob/master/docs/Common-errors.md) for common issues.
Check this [page](common-errors.md) for common issues.

View File

Before

Width:  |  Height:  |  Size: 203 KiB

After

Width:  |  Height:  |  Size: 203 KiB

View File

Before

Width:  |  Height:  |  Size: 416 KiB

After

Width:  |  Height:  |  Size: 416 KiB

17
docs/index.md Normal file
View File

@ -0,0 +1,17 @@
# Cutter
Cutter is a C++ graphical user interface for the reverse engineering framework radare2.
## Getting started
To start playing with Cutter, download the software for your platform on this link: [https://github.com/radareorg/cutter/releases](https://github.com/radareorg/cutter/releases).
### Analysis
### Interface
## Building Cutter
To build Cutter, follow [this guide.][compiling.md]