diff options
author | Aqua-sama <aqua@iserlohn-fortress.net> | 2017-04-19 14:11:32 +0200 |
---|---|---|
committer | Aqua-sama <aqua@iserlohn-fortress.net> | 2017-04-19 14:11:32 +0200 |
commit | 0ef7358b510cbd97460ca9f82d54d8c7276f55ec (patch) | |
tree | 3f244b8d44caa3cac146a5038026a633d18afeee | |
parent | Address bar menu and search (diff) | |
download | smolbote-0ef7358b510cbd97460ca9f82d54d8c7276f55ec.tar.xz |
Updated documentation
-rw-r--r-- | CONTRIBUTING.md | 13 | ||||
-rw-r--r-- | data/poi.toml (renamed from data/poi.conf) | 0 | ||||
-rw-r--r-- | docs/header-gpl3.txt | 20 | ||||
-rw-r--r-- | smolbote.qbs | 16 | ||||
l--------- | test/poi.conf | 2 |
5 files changed, 39 insertions, 12 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 1d99985..03e0879 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -47,11 +47,18 @@ Major bugfixes and each new feature should get a revision. /test | test run location, mainly for QtCreator ### Licensing -Please include an appropriate license header in any file you add. +Please include an appropriate license header in any file you add. A sample GPLv3 +header is included in docs/header-gpl3.txt. + +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})/ +``` ### QtCreator * In the project Run Settings set the working directory to _$repo/test_, and the -command line arguments to _-c ./config.ini_. +command line arguments to _-c poi.conf_. ### firejail -Any submitted modifications must work with the provided firejail profile. +Any submitted modifications should work with the provided firejail profile. diff --git a/data/poi.conf b/data/poi.toml index f972a50..f972a50 100644 --- a/data/poi.conf +++ b/data/poi.toml diff --git a/docs/header-gpl3.txt b/docs/header-gpl3.txt new file mode 100644 index 0000000..9b19afd --- /dev/null +++ b/docs/header-gpl3.txt @@ -0,0 +1,20 @@ +/******************************************************************************* + ** + ** smolbote: yet another qute browser + ** Copyright (C) $CURRENTYEAR $AUTHOR + ** + ** This program is free software: you can redistribute it and/or modify + ** it under the terms of the GNU General Public License as published by + ** the Free Software Foundation, either version 3 of the License, or + ** (at your option) any later version. + ** + ** This program is distributed in the hope that it will be useful, + ** but WITHOUT ANY WARRANTY; without even the implied warranty of + ** MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + ** GNU General Public License for more details. + ** + ** You should have received a copy of the GNU General Public License + ** along with this program. If not, see <http://www.gnu.org/licenses/>. + ** + ******************************************************************************/ + diff --git a/smolbote.qbs b/smolbote.qbs index e03f692..f3b5ee6 100644 --- a/smolbote.qbs +++ b/smolbote.qbs @@ -73,6 +73,14 @@ Project { "src/forms/aboutdialog.cpp", "src/forms/aboutdialog.h", "src/forms/aboutdialog.ui", + "src/widgets/dockingwidget.cpp", + "src/widgets/dockingwidget.h", + "src/widgets/loadingbar.cpp", + "src/widgets/loadingbar.h", + "src/widgets/urllineedit.cpp", + "src/widgets/urllineedit.h", + "src/widgets/webviewtabbar.cpp", + "src/widgets/webviewtabbar.h", ] } @@ -143,14 +151,6 @@ Project { "src/settings.h", "src/webengine/webview.cpp", "src/webengine/webview.h", - "src/widgets/dockingwidget.cpp", - "src/widgets/dockingwidget.h", - "src/widgets/loadingbar.cpp", - "src/widgets/loadingbar.h", - "src/widgets/urllineedit.cpp", - "src/widgets/urllineedit.h", - "src/widgets/webviewtabbar.cpp", - "src/widgets/webviewtabbar.h", ] Group { diff --git a/test/poi.conf b/test/poi.conf index 2266797..a713f73 120000 --- a/test/poi.conf +++ b/test/poi.conf @@ -1 +1 @@ -../data/poi.conf
\ No newline at end of file +../data/poi.toml
\ No newline at end of file |