added clangformat.txt and updated readme

This commit is contained in:
fourtf 2017-02-06 14:47:47 +01:00
parent 759e0aea50
commit 29e9d00f36
2 changed files with 31 additions and 0 deletions

View file

@ -6,3 +6,6 @@ Chatterino 2 is the second installment of my twitch chat client series "Chatteri
1. download the [boost library](https://sourceforge.net/projects/boost/files/boost/1.63.0/boost_1_63_0.zip/download) and extract it to `C:\local\boost` 1. download the [boost library](https://sourceforge.net/projects/boost/files/boost/1.63.0/boost_1_63_0.zip/download) and extract it to `C:\local\boost`
2. download binaries for OpenSSL >= 1.0.2 or compile it from source. [example download](https://indy.fulgan.com/SSL/) 2. download binaries for OpenSSL >= 1.0.2 or compile it from source. [example download](https://indy.fulgan.com/SSL/)
3. Place libeay32.dll and ssleay32.dll from OpenSSL in a directory in PATH. 3. Place libeay32.dll and ssleay32.dll from OpenSSL in a directory in PATH.
## code style
The code is normally formated using clang format in qt creator. [clangformat.txt](https://github.com/fourtf/chatterino2/blob/master/clangformat.txt) conatins the style file for clang format.

28
clangformat.txt Normal file
View file

@ -0,0 +1,28 @@
IndentCaseLabels: true
BasedOnStyle: Google
IndentWidth: 4
Standard: Auto
PointerBindsToType: false
Language: Cpp
SpacesBeforeTrailingComments: 2
AccessModifierOffset: -1
AlignEscapedNewlinesLeft: true
AlwaysBreakAfterDefinitionReturnType: true
AlwaysBreakBeforeMultilineStrings: false
BreakConstructorInitializersBeforeComma: true
# BreakBeforeBraces: Linux
BreakBeforeBraces: Custom
AccessModifierOffset: -4
ConstructorInitializerAllOnOneLineOrOnePerLine: false
AllowShortFunctionsOnASingleLine: false
AllowShortIfStatementsOnASingleLine: false
AllowShortLoopsOnASingleLine: false
DerivePointerBinding: false
BraceWrapping: {
AfterNamespace: 'false'
AfterClass: 'true'
BeforeElse: 'false'
AfterControlStatement: 'false'
AfterFunction: 'true'
BeforeCatch: 'false'
}