diff options
| -rw-r--r-- | BUILDING.md | 8 | ||||
| -rw-r--r-- | CONTRIBUTING.md | 9 |
2 files changed, 11 insertions, 6 deletions
diff --git a/BUILDING.md b/BUILDING.md index aa693dd..dabd1e8 100644 --- a/BUILDING.md +++ b/BUILDING.md @@ -19,7 +19,8 @@ make ### Notes * Don't do any steps marked [TODO] * Windows: MSVC compiler is required because of QtWebEngine dependency -* Windows: Passing the -v or -h parameters creates a dialog box instead of writing the output to stdout. This is Qt behaviour. +* Windows: Passing the -v or -h parameters creates a dialog box instead of +writing the output to stdout. This is Qt behaviour. ## Deploying @@ -35,7 +36,8 @@ Signing a tarball: gpg -u $FINGERPRINT -b $FILENAME ``` -u, --local-user name -> Use name as the user ID to sign. This option is silently ignored for the list commands, so that it can be used in an options file. +> Use name as the user ID to sign. This option is silently ignored for the list +commands, so that it can be used in an options file. -b, --detach-sign > Make a detached signature. @@ -53,5 +55,5 @@ sha512sum --check checksum.sha512 ### Windows ``` -QT_DIR\QT_VERSION\msvc2015_64\windeployqt.exe build-PROFILE\release\qtbrowser.exe +QT_DIR\QT_VER\msvc2015_64\windeployqt.exe build-PROFILE\release\qtbrowser.exe ``` diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 09b059f..58ba086 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,14 +1,17 @@ -## Folder structure +### Folder structure + folder | description + ------ | ----------- /src | source code /src/widgets | subclassed Qt widgets /src/forms | Qt UI forms and classes /src/webengine | QWebEngine* subclasses /test | test run location, mainly for QtCreator -## Code style -## Testing +### QtCreator +* In the project Run Settings set the working directory to _$repo/test_, and the +command line arguments to _-c ./config.ini_. ### firejail Any submitted modifications must work with the provided firejail profile. |