diff options
| author | Aqua-sama <aqua@iserlohn-fortress.net> | 2018-10-12 18:19:40 +0200 |
|---|---|---|
| committer | Aqua-sama <aqua@iserlohn-fortress.net> | 2018-10-12 21:23:30 +0200 |
| commit | 43a5be4dfa77061ffb4488f81aa965940c1d6c2d (patch) | |
| tree | 0a4186ee2949af781563deb95e1ca182d86ce160 /doc | |
| parent | Unlink plugins from lib/ libraries (diff) | |
| download | smolbote-43a5be4dfa77061ffb4488f81aa965940c1d6c2d.tar.xz | |
Update readme
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/Development.asciidoc | 15 |
1 files changed, 12 insertions, 3 deletions
diff --git a/doc/Development.asciidoc b/doc/Development.asciidoc index c6c49fb..c849d67 100644 --- a/doc/Development.asciidoc +++ b/doc/Development.asciidoc @@ -1,10 +1,19 @@ == Guidelines +smolbote is written under the C++17 standard, without any compiler-specific +extensions. Source code should be kept as platform-agnostic as possible. + +=== General +* All behaviour, where possible, should be configurable. +* Configuration is stored in plaintext files, and option names should be as + self-descriptive as possible. +* Use sane defaults. Normally, the program should "just work". + === Qt * Check pointers with Q_CHECK_PTR. -* Avoid using connect SIGNAL and SLOT. Instead use &Class::method. This way - connects are checked during the compile, not at runtime. -* Where possible, prefer QVector over QList: http://lists.qt-project.org/pipermail/development/2017-March/029040.html +* Use the Qt5 signal/slot syntax (&Class::method) over the old string-based + syntax (SIGNAL/SLOT). This enables compile-time connect checks. +* Prefer QVector over QList: http://lists.qt-project.org/pipermail/development/2017-March/029040.html === clazy You can use https://github.com/KDE/clazy[clazy] to check Qt semantics. |