From 711ed505dcaff0e9e2535de2f88c923fdf109074 Mon Sep 17 00:00:00 2001 From: xarkes Date: Thu, 28 Feb 2019 11:21:21 +0100 Subject: [PATCH] Updated links to the documentation (#1229) * Updated links to the documentation --- .github/PULL_REQUEST_TEMPLATE.md | 2 +- CONTRIBUTING.md | 5 +++-- README.md | 4 ++-- docs/source/building.rst | 27 ++++++++++++++++----------- docs/source/index.rst | 11 +++++------ src/org.radare.Cutter.appdata.xml | 2 +- 6 files changed, 28 insertions(+), 23 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 62acd4e3..0371038c 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -10,7 +10,7 @@ Demonstrate the code is solid. Example: The exact commands you ran and their out **Code formatting** -Make sure you ran astyle on your code before making the PR. Check our contribution guidelines here: https://radareorg.github.io/cutter/code.html +Make sure you ran astyle on your code before making the PR. Check our contribution guidelines here: https://cutter.re/docs/code.html **Closing issues** diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c7b62536..27b2107b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -12,11 +12,12 @@ You can create an issue by clicking on [this link](https://github.com/radareorg/ Note that cutter is still under development and many parts of the code are to be improved. The best way is to check the opened issues [here](https://github.com/radareorg/cutter/issues) or discuss with radareorg team. -Please follow our contribution guidelines: https://radareorg.github.io/cutter/code.html +Please follow our contribution guidelines: https://cutter.re/docs/code.html ## Contributing to the documentation -The documentation is something important for newcomers. As of today the documentation can be found [here](https://radareorg.github.io/cutter/) and it stands in the [docs](https://github.com/radareorg/cutter/tree/master/docs) folder. +The documentation is something important for newcomers. As of today the documentation can be found [here](https://cutter.re/docs/) and it stands in the [docs](https://github.com/radareorg/cutter/tree/master/docs) folder. +The API Reference is automatically generated from the source code, so it is strongly advised to document your code. Check issues marked as "Documentation" on our issues [list](https://github.com/radareorg/cutter/issues?q=is%3Aissue+is%3Aopen+label%3ADocumentation). ## Translations diff --git a/README.md b/README.md index 7a9d0357..7b0846f4 100644 --- a/README.md +++ b/README.md @@ -23,7 +23,7 @@ You can download the latest release [here](https://github.com/radareorg/cutter/r ## Building from sources -To build Cutter on your local machine, please follow this guide: [Building from source](https://radareorg.github.io/cutter/building.html) +To build Cutter on your local machine, please follow this guide: [Building from source](https://cutter.re/docs/building.html) ## Docker @@ -31,7 +31,7 @@ To deploy *cutter* using a pre-built `Dockerfile`, it's possible to use the [pro # Documentation -You can find our documentation [here](https://radareorg.github.io/cutter/). +You can find our documentation [here](https://cutter.re/docs/). # Help diff --git a/docs/source/building.rst b/docs/source/building.rst index 43cafe0e..bf002484 100644 --- a/docs/source/building.rst +++ b/docs/source/building.rst @@ -10,22 +10,22 @@ First you must get the source of Cutter by cloning the repository: 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 \* Python3.6 +In any case, there are obviously some requirements: +- Radare2 installed from submodule +- Qt 5.9 or above +- Python3.6 **Before compiling, note that we also provide binaries available for -windows/linux/MacOS -X**\ `here `__\ **.** +windows/linux/MacOS **\ `here `__\ **.** -------------- 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) +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) -------------- @@ -156,15 +156,20 @@ Download and unpack source root directory. Environment settings (example for x64 version): -``batch :: Export MSVC variables 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%"`` -Install Meson: +.. code:: batch + :: Export MSVC variables + 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%" +Install Meson: .. code:: batch python -m pip install meson To compile Cutter run: - .. code:: batch CALL prepare_r2.bat diff --git a/docs/source/index.rst b/docs/source/index.rst index ed4addb4..d1f46a08 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -14,11 +14,10 @@ Get Cutter Cutter is available for all platforms (Linux, OS X, Windows). You can download the latest release -`here `__. \* 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.4-x86_64.AppImage`` \* -``./Cutter-v1.7.4-x86_64.AppImage`` +`here `__. +- 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.4-x86_64.AppImage`` Building from sources @@ -34,7 +33,7 @@ You can contact the *Cutter* developers and community on: - Telegram: https://t.me/r2cutter - #cutter on irc.freenode.net -- Twitter: [@r2gui](https://twitter.com/r2gui) +- Twitter: https://twitter.com/r2gui Want to help the project? ------------------------- diff --git a/src/org.radare.Cutter.appdata.xml b/src/org.radare.Cutter.appdata.xml index 535e3db9..67cc49fc 100644 --- a/src/org.radare.Cutter.appdata.xml +++ b/src/org.radare.Cutter.appdata.xml @@ -21,7 +21,7 @@ - https://radareorg.github.io/cutter/ + https://cutter.re/docs/ xarkes