diff options
author | Aqua-sama <aqua@iserlohn-fortress.net> | 2017-12-14 15:41:33 +0100 |
---|---|---|
committer | Aqua-sama <aqua@iserlohn-fortress.net> | 2017-12-14 15:41:33 +0100 |
commit | 6385450e7bf9e573da0c274e7a04ed816d9e7f6a (patch) | |
tree | f539f6b83777c3fce184d727b2e8db9eaba12262 /docs/manual | |
parent | Cleaned up UrlLineEdit (diff) | |
download | smolbote-6385450e7bf9e573da0c274e7a04ed816d9e7f6a.tar.xz |
Updated documentation
Diffstat (limited to 'docs/manual')
-rw-r--r-- | docs/manual/Building.Compiling.md | 28 | ||||
-rw-r--r-- | docs/manual/Building.Dependencies.md | 2 | ||||
-rw-r--r-- | docs/manual/Contributing.Style.md | 28 | ||||
-rw-r--r-- | docs/manual/Contributing.Submitting.md (renamed from docs/manual/Contributing.Code.md) | 0 | ||||
-rw-r--r-- | docs/manual/SUMMARY.md | 2 |
5 files changed, 14 insertions, 46 deletions
diff --git a/docs/manual/Building.Compiling.md b/docs/manual/Building.Compiling.md index bf6637e..7505755 100644 --- a/docs/manual/Building.Compiling.md +++ b/docs/manual/Building.Compiling.md @@ -1,6 +1,6 @@ # Compiling -## Creating qbs configuration +## Create qbs configuration Before you can build anything with qbs, you need to set up the compiler toolchain as well as Qt. @@ -9,36 +9,20 @@ qbs setup-toolchains --detect qbs setup-qt /usr/bin/qmake-qt5 qt5 ``` +## Compile -## Compiling - -* Create a build folder +1. Create a build folder ``` [smolbote repo]$ mkdir ../build ``` -* Run qbs +2. Build ``` [smolbote repo]$ qbs build -d ../build profile:qt5 release ``` This installs the files to ../build/release/install-root. -* Run +3. Install ``` -[smolbote repo]$ qbs run -d ../build -p poi profile:qt5 release +[smolbote repo]$ qbs install -d ../build -p poi --install-root "/install/root" profile:qt5 release ``` - -## mach -mach is a helper script that can build and run smolbote. - -#### setup -./mach setup creates a qbs configuration in :settingsDir, -by default ../build/config. - -You can edit this using qbs-config-ui --settings-dir ../build/config. - -#### run - -#### clean - -#### build diff --git a/docs/manual/Building.Dependencies.md b/docs/manual/Building.Dependencies.md index 2f9bcdd..3b03e1b 100644 --- a/docs/manual/Building.Dependencies.md +++ b/docs/manual/Building.Dependencies.md @@ -5,7 +5,7 @@ - at least 5.9 - core, widgets - webengine, webenginewidgets -- [libtoml](https://github.com/mayah/tinytoml) (included in source) +- [libconfig](https://hyperrealm.github.io/libconfig/) ### Tools * A working compiler diff --git a/docs/manual/Contributing.Style.md b/docs/manual/Contributing.Style.md index 1ab6b17..4d7ef1b 100644 --- a/docs/manual/Contributing.Style.md +++ b/docs/manual/Contributing.Style.md @@ -2,37 +2,21 @@ ## Guidelines * Use generic formats -* Where possible, use QVector over QList: -http://lists.qt-project.org/pipermail/development/2017-March/029040.html +* Where possible, use QVector over QList: http://lists.qt-project.org/pipermail/development/2017-March +/029040.html +* Check pointers with Q_CHECK_PTR before returning them ## Versioning -#### Major version -Changed infrequently and almost entirely out of foppery and whim. - -#### Minor version -Milestone of multiple features. - -#### Revision -Major bugfixes and each new feature should get a revision. +- major version: Changed infrequently and almost entirely out of foppery and whim. +- minor version: Milestone of multiple features. +- revision: Major bugfixes and each new feature should get a revision. ### Branching * master - main branch, should be kept up-to-date, and have only working code * next - next stable release preparation, mostly for bugfixes * development - development branch, anything goes there -### Folder structure - - folder | description - ------ | ----------- -/src | source code -/src/widgets | subclassed Qt widgets -/src/formats | file format parsing (toml, xbel) -/src/forms | Qt UI forms and classes -/src/webengine | QWebEngine subclasses -/test | test run location, mainly for QtCreator - - ## clazy You can use [clazy](https://github.com/KDE/clazy) to check Qt semantics. Requires clang. diff --git a/docs/manual/Contributing.Code.md b/docs/manual/Contributing.Submitting.md index d84e14f..d84e14f 100644 --- a/docs/manual/Contributing.Code.md +++ b/docs/manual/Contributing.Submitting.md diff --git a/docs/manual/SUMMARY.md b/docs/manual/SUMMARY.md index 5362502..ca7b072 100644 --- a/docs/manual/SUMMARY.md +++ b/docs/manual/SUMMARY.md @@ -11,4 +11,4 @@ - [Contributing](./Contributing.md) - [Reporting bugs](./Contributing.Bugs.md) - [Code style](./Contributing.Style.md) - - [Before you submit](./Contributing.Code.md) + - [Submitting](./Contributing.Submitting.md) |