aboutsummaryrefslogtreecommitdiff
path: root/CONTRIBUTING.md
diff options
context:
space:
mode:
authorAqua-sama <aqua@iserlohn-fortress.net>2017-01-14 22:02:37 +0100
committerAqua-sama <aqua@iserlohn-fortress.net>2017-01-14 22:02:37 +0100
commitd593a228bc8d20ec2f99784ceb6a4e53db469516 (patch)
tree76e42d6949502b8a22987d458d8dcc5f0ead6581 /CONTRIBUTING.md
parentConfiguration by default is read from default location instead of current folder (diff)
downloadsmolbote-d593a228bc8d20ec2f99784ceb6a4e53db469516.tar.xz
Updated Contributing
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r--CONTRIBUTING.md9
1 files changed, 6 insertions, 3 deletions
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.