diff --git a/docs/.gitignore b/docs/.gitignore new file mode 100644 index 00000000..57510a2b --- /dev/null +++ b/docs/.gitignore @@ -0,0 +1 @@ +_site/ diff --git a/docs/_config.yml b/docs/_config.yml index 79243430..13f53758 100644 --- a/docs/_config.yml +++ b/docs/_config.yml @@ -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 diff --git a/docs/Compiling-with-CMake.md b/docs/cmake.md similarity index 100% rename from docs/Compiling-with-CMake.md rename to docs/cmake.md diff --git a/docs/Common-errors.md b/docs/common-errors.md similarity index 90% rename from docs/Common-errors.md rename to docs/common-errors.md index 63bd2b08..abe21c1f 100644 --- a/docs/Common-errors.md +++ b/docs/common-errors.md @@ -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). diff --git a/docs/Compiling.md b/docs/compiling.md similarity index 86% rename from docs/Compiling.md rename to docs/compiling.md index deabf788..d582737a 100644 --- a/docs/Compiling.md +++ b/docs/compiling.md @@ -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. diff --git a/docs/cutter_path_settings.png b/docs/images/cutter_path_settings.png similarity index 100% rename from docs/cutter_path_settings.png rename to docs/images/cutter_path_settings.png diff --git a/docs/screenshot.png b/docs/images/screenshot.png similarity index 100% rename from docs/screenshot.png rename to docs/images/screenshot.png diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 00000000..34fcf800 --- /dev/null +++ b/docs/index.md @@ -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] +