From e6387ef879fbc4dc9ca14ea8545b4439216891e3 Mon Sep 17 00:00:00 2001
From: Itay Cohen <itaycohen23@gmail.com>
Date: Sun, 30 Sep 2018 22:53:27 +0300
Subject: [PATCH] improve docs (#741)

---
 docs/_config.yml      |  2 +-
 docs/building.md      | 24 +++++++++++++++++-------
 docs/common-errors.md |  7 ++++++-
 docs/index.md         | 25 ++++++++++++++++---------
 4 files changed, 40 insertions(+), 18 deletions(-)

diff --git a/docs/_config.yml b/docs/_config.yml
index d9e30224..74ffb2ed 100644
--- a/docs/_config.yml
+++ b/docs/_config.yml
@@ -44,7 +44,7 @@ description: >-
 
 # Build settings
 markdown: kramdown
-remote_theme: allejo/jekyll-docs-theme
+remote_theme: radareorg/cutter-jekyll-docs-theme
 
 plugins:
   - jekyll-remote-theme
diff --git a/docs/building.md b/docs/building.md
index 9b71b992..6d585d3e 100644
--- a/docs/building.md
+++ b/docs/building.md
@@ -8,17 +8,22 @@ In any case, there are obviously some requirements:
 
 **Before compiling, note that we also provide binaries available for windows/linux/MacOS X [here](https://github.com/radareorg/cutter/releases).**
 
-## Building options
+---
+
+
+# Building options
 
 Note that there are two major building options available:
 * `CUTTER_ENABLE_JUPYTER` is used to compile Cutter with bundled Python and Jupyter module
 * `CUTTER_ENABLE_QTWEBENGINE` is used to compile Cutter with bundled QtWebEngine (to ease jupyter console usage)
 
+---
+
 # Building with Qmake
 
-## Requirements
+### Requirements
 
-### Compiling on Linux / OsX
+#### Compiling on Linux / OsX
 
 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.
 
@@ -29,12 +34,15 @@ qmake ../src/Cutter.pro
 make
 cd ..
 ```
+
+---
+
 # Building with Cmake
 
-## Requirements
+### Requirements
 * CMake >= 3.1
 
-## Building on Linux
+### Building on Linux
 
 The root for CMake is in src/. In-source builds are **not allowed**, so you **must** run CMake from a separate directory:
 ```
@@ -49,7 +57,9 @@ If all went well, you should now have a working Makefile in your build directory
 make
 ```
 
-## Building on Windows
+---
+
+# Building on Windows
 
 Alternatively, on Windows you can run something like this (depending on your Cmake installation)
 ```batch
@@ -85,7 +95,7 @@ This can be resolved by either:
 pip3 install notebook jupyter_client
 ```
 
-# Building with Meson (Windows)
+## Building with Meson (Windows)
 
 Additional requirements:
 
diff --git a/docs/common-errors.md b/docs/common-errors.md
index 4752c6c6..0400ff01 100644
--- a/docs/common-errors.md
+++ b/docs/common-errors.md
@@ -2,10 +2,15 @@
 
 This page lists common issues met by our users.
 
+---
+
 # AppImage crashes
 
+
 If the linux AppImage binary crashes upon startup, make sure your `LD_LIBRARY_PATH` environment variable is empty. [#579](https://github.com/radareorg/cutter/issues/579)
 
+---
+
 # Compilation error
 > r_core development package not found
 
@@ -17,7 +22,7 @@ On OS X you can also try:
 - `PKG_CONFIG_PATH=$HOME/bin/prefix/radare2/lib/pkgconfig qmake`
 - `PKG_CONFIG_PATH=$HOME/cutter/radare2/pkgcfg qmake` (for modern version and if radare2 was installed like the submodule)
 
-![PATH variable settings](images/cutter_path_settings.png)
+<img src="/images/cutter_path_settings.png" alt="Cutter screenshot">
 
 Or radare2 libs could be installed to `/usr/lib/pkgconfig/`, so you can add variable `PKG_CONFIG_PATH` with value `/usr/lib/pkgconfig/`
 
diff --git a/docs/index.md b/docs/index.md
index a58e178a..d5b09d3a 100644
--- a/docs/index.md
+++ b/docs/index.md
@@ -4,20 +4,27 @@ homepage: true
 
 # Overview
 
-Cutter is a C++ graphical user interface for the reverse engineering framework radare2.
+Cutter is a Qt and C++ GUI for radare2. Its goal is making an advanced, customizable and FOSS reverse-engineering platform while keeping the user experience at mind. Cutter is created by reverse engineers for reverse engineers.
 
-[//]: # ![Screenshot](https://raw.githubusercontent.com/radareorg/cutter/master/docs/images/screenshot.png)
+<img src="/images/screenshot.png" alt="Cutter screenshot">
 
-# 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).
+# Get Cutter
 
-## Analysis
+Cutter is available for all platforms (Linux, OS X, Windows).
+You can download the latest release [here](https://github.com/radareorg/cutter/releases).
+ * OSX: Download the latest `.dmg` file.
+ * Windows: Download the latest archive.
+ * Linux: use the AppImage file. Then just make it executable and run it:
+     * `chmod +x Cutter-v1.7.1-x86_64.AppImage`
+     * `./Cutter-v1.7.1-x86_64.AppImage`
 
-Analysis in Cutter is (for now) quite different than other reverse engineering applications.
-The analysis must complete before you can actually work on the binary.
+---
+
+# Building from sources
+
+To build Cutter on your local machine, please follow this guide: [Building from source](building.html)
 
-# Building Cutter
 
-To build Cutter, follow [this guide](building.md).