From ae2a713f26fd58f397aaf93242f24c85dee98a2b Mon Sep 17 00:00:00 2001
From: Aqua-sama <aqua@iserlohn-fortress.net>
Date: Wed, 3 Oct 2018 16:48:26 +0200
Subject: Convert documentation into asciidoc from markdown

---
 doc/Building/Breakpad.asciidoc | 20 ++++++++++++++++++++
 doc/Building/QtWebEngine.md    |  7 -------
 doc/Building/Windows.asciidoc  | 26 ++++++++++++++++++++++++++
 doc/Building/smolbote.md       | 30 ------------------------------
 4 files changed, 46 insertions(+), 37 deletions(-)
 create mode 100644 doc/Building/Breakpad.asciidoc
 delete mode 100644 doc/Building/QtWebEngine.md
 create mode 100644 doc/Building/Windows.asciidoc
 delete mode 100644 doc/Building/smolbote.md

(limited to 'doc/Building')

diff --git a/doc/Building/Breakpad.asciidoc b/doc/Building/Breakpad.asciidoc
new file mode 100644
index 0000000..9cc561e
--- /dev/null
+++ b/doc/Building/Breakpad.asciidoc
@@ -0,0 +1,20 @@
+== Breakpad
+
+=== Enabling breakpad
+Use `-DBreakpad=On` cmake option. This requires either Breakpad be installed as
+a package, or that it is already built. Check 3rd-party/breakpad/CMakeLists.txt.
+
+=== Producing symbols
+[source, sh]
+----
+tools/linux/dump_syms/dump_syms ./poi > poi.sym
+head -n1 poi.sym
+mkdir -p ./symbols/poi/<hex>
+mv poi.sym ./symbols/poi/<hex>
+----
+
+=== Processing minidump
+[source, sh]
+----
+processor/minidump_stackwalk minidump.dmp ./symbols
+----
diff --git a/doc/Building/QtWebEngine.md b/doc/Building/QtWebEngine.md
deleted file mode 100644
index 7d72dd6..0000000
--- a/doc/Building/QtWebEngine.md
+++ /dev/null
@@ -1,7 +0,0 @@
-- download qtwebengine
-
-~~~sh
-mkdir build && cd build
-qmake ../qtwebengine-version-source/qtwebengine.pro
-make
-~~~
diff --git a/doc/Building/Windows.asciidoc b/doc/Building/Windows.asciidoc
new file mode 100644
index 0000000..4c1fc20
--- /dev/null
+++ b/doc/Building/Windows.asciidoc
@@ -0,0 +1,26 @@
+== Building on Windows
+[source, bat]
+----
+set INSTALL_DIR="C:\projects\smolbote-install"
+mkdir %INSTALL_DIR%
+
+mkdir C:\projects\smolbote-build
+cd C:\projects\smolbote-build
+
+set QT="C:\Qt\5.11\msvc2017_64"
+set BOOST_ROOT="C:\Libraries\boost_1_66_0"
+set BOOST_LIBDIR="C:\Libraries\boost_1_66_0\lib64-msvc-14.1"
+
+cmake  -G "Visual Studio 15 2017 Win64" -DCMAKE_BUILD_TYPE=Release 
+    -DCMAKE_INSTALL_PREFIX=%INSTALL_DIR% 
+    -DCMAKE_PREFIX_PATH=%QT%;%BOOST_ROOT% 
+    -DBOOST_ROOT=%BOOST_ROOT% -DBOOST_LIBRARYDIR=%BOOST_LIBDIR% -DBoost_USE_STATIC_LIBS=On 
+    C:\projects\smolbote
+
+cmake --build . --target poi --config Release
+cmake --build . --target install --config Release
+cd %INSTALL_DIR%
+C:\Qt\5.11\msvc2017_64\bin\windeployqt.exe bin\poi.exe
+
+7z a C:\projects\smolbote\build.7z %INSTALL_DIR%
+----
diff --git a/doc/Building/smolbote.md b/doc/Building/smolbote.md
deleted file mode 100644
index e40132c..0000000
--- a/doc/Building/smolbote.md
+++ /dev/null
@@ -1,30 +0,0 @@
-## Customizing
-Set through vendor.cmake.
-
-### Configuration defaults
-
-### Version information
-Building without git metadata requires the version be set in vendor.cmake.
-
-
-## Building on Windows
-
-~~~sh
-set INSTALL_DIR="C:\projects\smolbote-install"
-mkdir %INSTALL_DIR%
-
-mkdir C:\projects\smolbote-build
-cd C:\projects\smolbote-build
-
-set QT="C:\Qt\5.11.0\msvc2017_64"
-set BOOST_ROOT="C:\Libraries\boost_1_66_0"
-set BOOST_LIBDIR="C:\Libraries\boost_1_66_0\lib64-msvc-14.1"
-cmake  -G "Visual Studio 15 2017 Win64" -DCMAKE_BUILD_TYPE=Release -DCMAKE_INSTALL_PREFIX=%INSTALL_DIR% -DCMAKE_PREFIX_PATH=%QT%;%BOOST_ROOT% -DBOOST_ROOT=%BOOST_ROOT% -DBOOST_LIBRARYDIR=%BOOST_LIBDIR% -DBoost_USE_STATIC_LIBS=On C:\projects\smolbote-hg
-cmake --build . --target poi --config Release
-cmake --build . --target install --config Release
-cd %INSTALL_DIR%
-C:\Qt\5.10.1\msvc2017_64\bin\windeployqt.exe bin\poi.exe
-
-7z a C:\projects\smolbote-hg\smolbote.7z %INSTALL_DIR%
-~~~
-
-- 
cgit v1.2.1