From 6385450e7bf9e573da0c274e7a04ed816d9e7f6a Mon Sep 17 00:00:00 2001 From: Aqua-sama Date: Thu, 14 Dec 2017 15:41:33 +0100 Subject: Updated documentation --- docs/manual/Building.Compiling.md | 28 ++++--------------- docs/manual/Building.Dependencies.md | 2 +- docs/manual/Contributing.Code.md | 51 ---------------------------------- docs/manual/Contributing.Style.md | 28 ++++--------------- docs/manual/Contributing.Submitting.md | 51 ++++++++++++++++++++++++++++++++++ docs/manual/SUMMARY.md | 2 +- 6 files changed, 65 insertions(+), 97 deletions(-) delete mode 100644 docs/manual/Contributing.Code.md create mode 100644 docs/manual/Contributing.Submitting.md (limited to 'docs/manual') 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.Code.md b/docs/manual/Contributing.Code.md deleted file mode 100644 index d84e14f..0000000 --- a/docs/manual/Contributing.Code.md +++ /dev/null @@ -1,51 +0,0 @@ -# Before you submit - -## Licensing -Smolbote is licensed under GPLv3. Your code needs to be compatible with it, and -have a license header. - -The provided pre-commit hook uses the following regular expression to check for -a license: -```ruby -/Copyright\s\(C\)\s(\d{4}\s*-\s*){0,1}(#{Time.now.year})/ -``` - -```c -/****************************************************************************** - ** - ** smolbote: yet another qute browser - ** - ** Copyright (C) 2017 author - ** SPDX-License-Identifier: GPL-3.0 - ** License-Filename: docs/gpl-3.0.md - ** - ******************************************************************************/ -``` - -### SPDX-License-Identifier -A full list of license identifiers can be found on [the SPDX website](https://spdx.org/licenses/). - -### License-Filename -Path to the license text, relative to the repository root. - -## Style -Please use the [One True Brace style](https://en.wikipedia.org/wiki/Indent_style#Variant:_1TBS_.28OTBS.29). -Tabs are 4 spaces. - -For ease of use, you can set the following astyle configuration: -``` ---style=otbs ---attach-namespaces ---attach-inlines ---indent=spaces=4 -``` - -## Format patch for email -```sh -git format-patch hash -``` -where _hash_ is the commit immediately prior to the commit or series of commits -you want to submit. - -Attach the patch file and email it to _aqua at iserlohn-fortress.net_. If -possible, GPG sign the email. 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.Submitting.md b/docs/manual/Contributing.Submitting.md new file mode 100644 index 0000000..d84e14f --- /dev/null +++ b/docs/manual/Contributing.Submitting.md @@ -0,0 +1,51 @@ +# Before you submit + +## Licensing +Smolbote is licensed under GPLv3. Your code needs to be compatible with it, and +have a license header. + +The provided pre-commit hook uses the following regular expression to check for +a license: +```ruby +/Copyright\s\(C\)\s(\d{4}\s*-\s*){0,1}(#{Time.now.year})/ +``` + +```c +/****************************************************************************** + ** + ** smolbote: yet another qute browser + ** + ** Copyright (C) 2017 author + ** SPDX-License-Identifier: GPL-3.0 + ** License-Filename: docs/gpl-3.0.md + ** + ******************************************************************************/ +``` + +### SPDX-License-Identifier +A full list of license identifiers can be found on [the SPDX website](https://spdx.org/licenses/). + +### License-Filename +Path to the license text, relative to the repository root. + +## Style +Please use the [One True Brace style](https://en.wikipedia.org/wiki/Indent_style#Variant:_1TBS_.28OTBS.29). +Tabs are 4 spaces. + +For ease of use, you can set the following astyle configuration: +``` +--style=otbs +--attach-namespaces +--attach-inlines +--indent=spaces=4 +``` + +## Format patch for email +```sh +git format-patch hash +``` +where _hash_ is the commit immediately prior to the commit or series of commits +you want to submit. + +Attach the patch file and email it to _aqua at iserlohn-fortress.net_. If +possible, GPG sign the email. 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) -- cgit v1.2.1