aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorAqua-sama <aqua@iserlohn-fortress.net>2018-09-19 23:35:43 +0200
committerAqua-sama <aqua@iserlohn-fortress.net>2018-09-19 23:35:43 +0200
commit2c20acb1981fc8fbd884dbece2a1115ca37732d2 (patch)
treecafd753960b509f1c572448aaf7591a4ddb2dce8 /doc
parentclang-format pass (diff)
downloadsmolbote-2c20acb1981fc8fbd884dbece2a1115ca37732d2.tar.xz
Update documentation
Diffstat (limited to 'doc')
-rw-r--r--doc/Building/QtWebEngine.md7
-rw-r--r--doc/Building/smolbote.md (renamed from doc/Building.md)12
-rw-r--r--doc/Usage/CommandLine.md12
-rw-r--r--doc/Usage/Configuration.md53
-rw-r--r--doc/Usage/Profile.md (renamed from doc/Profile.md)0
-rw-r--r--doc/Usage/Session.md (renamed from doc/Session.md)0
6 files changed, 79 insertions, 5 deletions
diff --git a/doc/Building/QtWebEngine.md b/doc/Building/QtWebEngine.md
new file mode 100644
index 0000000..7d72dd6
--- /dev/null
+++ b/doc/Building/QtWebEngine.md
@@ -0,0 +1,7 @@
+- download qtwebengine
+
+~~~sh
+mkdir build && cd build
+qmake ../qtwebengine-version-source/qtwebengine.pro
+make
+~~~
diff --git a/doc/Building.md b/doc/Building/smolbote.md
index ab731dc..e40132c 100644
--- a/doc/Building.md
+++ b/doc/Building/smolbote.md
@@ -1,13 +1,15 @@
## Customizing
-### Version
+Set through vendor.cmake.
+
+### Configuration defaults
+
+### Version information
+Building without git metadata requires the version be set in vendor.cmake.
-### Configuration
-Configuration values are set from defaults.h, which is generated from
-defaults.h.{linux;win32}.
## Building on Windows
-~~~
+~~~sh
set INSTALL_DIR="C:\projects\smolbote-install"
mkdir %INSTALL_DIR%
diff --git a/doc/Usage/CommandLine.md b/doc/Usage/CommandLine.md
new file mode 100644
index 0000000..1c532ce
--- /dev/null
+++ b/doc/Usage/CommandLine.md
@@ -0,0 +1,12 @@
+## Command-line options
+
+### General
+* `-h`, `--help`: Display this help.
+* `-v`, `--version`: Display version information.
+* `--build`: Display build branch and commit.
+* `-c`, `--config`: Set configuration file.
+* `--no-remote`: Don't check for other instances when starting.
+
+### Tweaking configuration
+You can overwrite options at runtime using the option path as a command line
+parameter.
diff --git a/doc/Usage/Configuration.md b/doc/Usage/Configuration.md
new file mode 100644
index 0000000..3bf55b9
--- /dev/null
+++ b/doc/Usage/Configuration.md
@@ -0,0 +1,53 @@
+## Configuration
+
+The Configuration is loaded from _~/.config/smolbote/smolbote.cfg_. Most
+settings are only loaded on launch.
+
+For a full list of settings, check `--help`.
+
+### Browser (group: browser)
+
+### Main Window (group: mainwindow)
+A main window contains one or more subwindows.
+
+### Subwindow (group: window)
+A subwindow contains multiple tabs and functions similarly to a tab group.
+
+### Navigation bar (group: navigation)
+The navigation bar is the toolbar that holds the history, reload and home
+buttons, as well as the address bar. It can be made movable through the
+navigation.movable option.
+
+### Address bar (group: addressbar)
+
+### Filter (group: filter)
+
+### Plugins (group: plugins)
+Plugins a way of extending smolbote's functionality using the Qt plugin system.
+They are not to be confused with NPAPI/PPAPI or WebExtension plugins.
+
+To enable a plugin either copy it or symlink it in the plugins.path location,
+or set its absolute path as the plugins.path.
+
+### Profiles (group: profile)
+A Profile is a collection of settings, policies, scripts, cookies, cache and
+history. Profiles can be used to isolate pages from each other.
+
+Each window has a default profile it uses when opening new tabs. This can be
+set by the profile.default option, and can be changed from the window's menu.
+Additionally, tabs can have their profiles individually changed from their page
+menu.
+
+Because profiles store all their data separately, you can log in into the same
+site with a different account from each profile. However, links opened into new
+tabs will still use the subwindow's default profile. For example, you can set a
+profile to hold login information for a site, but all new tabs opened from that
+site would still be using the default off-the-record profile.
+
+Profile definitions are stored in the profiles.path location. To create a new
+profile, create a profile-id.profile file in that location.
+
+### Bookmarks (group: bookmarks)
+
+### Downloads (group: downloads)
+
diff --git a/doc/Profile.md b/doc/Usage/Profile.md
index d205a86..d205a86 100644
--- a/doc/Profile.md
+++ b/doc/Usage/Profile.md
diff --git a/doc/Session.md b/doc/Usage/Session.md
index 3018253..3018253 100644
--- a/doc/Session.md
+++ b/doc/Usage/Session.md