aboutsummaryrefslogtreecommitdiff
path: root/doc/Development
diff options
context:
space:
mode:
authorAqua-sama <aqua@iserlohn-fortress.net>2018-10-03 16:48:26 +0200
committerAqua-sama <aqua@iserlohn-fortress.net>2018-10-03 16:48:26 +0200
commitae2a713f26fd58f397aaf93242f24c85dee98a2b (patch)
treedb69c96f6419e011cfc1c6e6081613d7a0f0d7cc /doc/Development
parentSubwindow: only keep tab history for restore tab action (diff)
downloadsmolbote-ae2a713f26fd58f397aaf93242f24c85dee98a2b.tar.xz
Convert documentation into asciidoc from markdown
Diffstat (limited to 'doc/Development')
-rw-r--r--doc/Development/ManPage.asciidoc7
-rw-r--r--doc/Development/RepositoryCommands.asciidoc6
-rw-r--r--doc/Development/Translating.asciidoc16
-rw-r--r--doc/Development/Updater.asciidoc25
4 files changed, 54 insertions, 0 deletions
diff --git a/doc/Development/ManPage.asciidoc b/doc/Development/ManPage.asciidoc
new file mode 100644
index 0000000..4d8c015
--- /dev/null
+++ b/doc/Development/ManPage.asciidoc
@@ -0,0 +1,7 @@
+== manpage
+
+=== Generating manpage
+[code, sh]
+----
+a2x --format=manpage doc/smolbote.7.asciidoc
+----
diff --git a/doc/Development/RepositoryCommands.asciidoc b/doc/Development/RepositoryCommands.asciidoc
new file mode 100644
index 0000000..13e2f8e
--- /dev/null
+++ b/doc/Development/RepositoryCommands.asciidoc
@@ -0,0 +1,6 @@
+== Repository commands
+[code, sh]
+----
+# listing branches
+curl --request GET --url https://neueland.iserlohn-fortress.net/gitea/api/v1/repos/aqua/smolbote/branches
+----
diff --git a/doc/Development/Translating.asciidoc b/doc/Development/Translating.asciidoc
new file mode 100644
index 0000000..f79fa56
--- /dev/null
+++ b/doc/Development/Translating.asciidoc
@@ -0,0 +1,16 @@
+== Translating
+[code, sh]
+----
+# generating translations
+lupdate src/ lib/ -ts lang/<lang-id>.ts
+
+# updating translations
+lupdate src/ lib/ -no-obsolete -ts lang/<lang-id>.ts
+
+# generate lang/<lang-id>.qm
+lrelease lang/<land-id>.ts
+----
+
+=== Using translations
+ --browser.locale # set Qt translation; ex. de
+ --browser.translation # set translation file; ex. /home/user/.config/smolbote/lang/custom-translate.qm
diff --git a/doc/Development/Updater.asciidoc b/doc/Development/Updater.asciidoc
new file mode 100644
index 0000000..a039318
--- /dev/null
+++ b/doc/Development/Updater.asciidoc
@@ -0,0 +1,25 @@
+== Updater
+
+=== Creating manifest
+[code, sh]
+----
+find windows/ -type f | xargs sha512sum | sed 's/windows\///' > windows-sha512.txt
+find windows/ -type d -exec chmod 755 {} +
+----
+
+=== Building
+
+You can build for the current system using:
+[code, sh]
+----
+go build
+# remove debug information
+strip updater
+----
+
+You can also cross-compile for other systems by setting GOOS and GOARCH. For a
+list of supported platforms, use `go tool dist list`.
+[code, sh]
+----
+GOOS=windows GOARCH=amd64 go build
+----