aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorAqua-sama <aqua@iserlohn-fortress.net>2018-11-28 12:39:14 +0100
committerAqua-sama <aqua@iserlohn-fortress.net>2018-11-28 12:39:14 +0100
commit0b9cf8c968a89784b5c2b8afe1a819b33749165e (patch)
tree7153fc8fe5447ee710ce689352db6e0e3b8849cc /doc
parentAdd Session::view and Session::restoreView (diff)
downloadsmolbote-0b9cf8c968a89784b5c2b8afe1a819b33749165e.tar.xz
Rewrite Session saving and loading
Diffstat (limited to 'doc')
-rw-r--r--doc/Development/Configuring.asciidoc34
-rw-r--r--doc/Development/Session.asciidoc19
-rw-r--r--doc/Development/meson.asciidoc30
3 files changed, 49 insertions, 34 deletions
diff --git a/doc/Development/Configuring.asciidoc b/doc/Development/Configuring.asciidoc
deleted file mode 100644
index f436da5..0000000
--- a/doc/Development/Configuring.asciidoc
+++ /dev/null
@@ -1,34 +0,0 @@
-=== CMake
-
-==== Compiler flags
--pipe -fstack-protector-strong -fno-plt -fPIE
--march=native -mtune=native
-
-==== Install paths
-CMAKE_INSTALL_PREFIX is prepended onto all install paths. This variable defaults
-to /usr/local on *nix and c:/Program Files/${PROJECT_NAME} on Windows.
-
-On *nix you can use DESTDIR to relocate the entire installation. DESTDIR is
-prepended to CMAKE_INSTALL_PREFIX.
-
-This will install the project to /ports/pkg/install/usr:
-
-[source, sh]
-----
-cmake -DCMAKE_INSTALL_PREFIX=/usr ...
-...
-make DESTDIR=/ports/pkg/install install
-----
-
-==== clang-tidy
-CMAKE_CXX_CLANG_TIDY="clang-tidy;-checks=*"
-
-==== cppcheck
-CMAKE_CXX_CPPCHECK="cppcheck"
-
-==== ccache
--DCMAKE_CXX_COMPILER_LAUNCHER=ccache
-
-==== llvm libcpp
-CMAKE_CXX_FLAGS: -stdlib=libc++"
-CMAKE_EXE_LINKER_FLAGS -stdlib=libc++
diff --git a/doc/Development/Session.asciidoc b/doc/Development/Session.asciidoc
new file mode 100644
index 0000000..846d6a3
--- /dev/null
+++ b/doc/Development/Session.asciidoc
@@ -0,0 +1,19 @@
+== Session
+
+== Session JSON structure
+- windows: list of windows
+
+=== Window
+- subwindows: list of subwindows
+
+=== Subwindow
+- profile: profile ID
+- tabs: list of views
+- current: current tab index
+
+=== View
+- profile: profile ID
+- history: view history
+
+Storing history: compress, toBase64 (to make printable), toQString (to store in json)
+Restoring history: toLatin1 (turn into bytearray), fromBase64, uncompress
diff --git a/doc/Development/meson.asciidoc b/doc/Development/meson.asciidoc
new file mode 100644
index 0000000..1eb08c6
--- /dev/null
+++ b/doc/Development/meson.asciidoc
@@ -0,0 +1,30 @@
+==== Setting compiler
+Compiler can only be set when initially configuring the build, and cannot be
+changed with --reconfigure:
+
+[source, sh]
+----
+export CXX="ccache clang++"
+meson build-path
+----
+
+==== Setting linker
+[source, sh]
+----
+build% meson configure -Dcpp_link_args='-fuse_ld=gold'
+----
+
+==== Listing build options
+[source, sh]
+----
+build% meson configure
+----
+
+==== Changing build options
+[source, sh]
+----
+build% meson configure -D<option-name>=<enabled|disabled>
+# for example:
+build% meson configure -DPlasma=enabled
+----
+